summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-07-30 16:24:46 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-07-30 16:24:46 +0900
commit6b567fdc0585cf77c8104df9b0a75c9fa7d41ec7 (patch)
tree1c128cae1b0846826269eb86abf731153071ea97
parentFix doc (diff)
downloadsharkey-6b567fdc0585cf77c8104df9b0a75c9fa7d41ec7.tar.gz
sharkey-6b567fdc0585cf77c8104df9b0a75c9fa7d41ec7.tar.bz2
sharkey-6b567fdc0585cf77c8104df9b0a75c9fa7d41ec7.zip
ドキュメントにDisqus設置
-rw-r--r--src/docs/api/endpoints/view.pug4
-rw-r--r--src/docs/base.pug22
-rw-r--r--src/docs/style.styl7
-rw-r--r--src/server/web/docs.ts5
4 files changed, 34 insertions, 4 deletions
diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug
index 1d7801ab4b..76e1183302 100644
--- a/src/docs/api/endpoints/view.pug
+++ b/src/docs/api/endpoints/view.pug
@@ -10,9 +10,9 @@ block main
p#url
span.method POST
span.host
- = url.host
+ = endpointUrl.host
| /
- span.path= url.path
+ span.path= endpointUrl.path
if endpoint.desc
p#desc= endpoint.desc[lang] || endpoint.desc['ja']
diff --git a/src/docs/base.pug b/src/docs/base.pug
index b67fd630c4..aeafaeffff 100644
--- a/src/docs/base.pug
+++ b/src/docs/base.pug
@@ -34,6 +34,28 @@ html(lang= lang)
if content
| !{content}
+ aside.
+ <div id="disqus_thread"></div>
+ <script>
+
+ /**
+ * RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
+ * LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables*/
+ /*
+ var disqus_config = function () {
+ this.page.url = PAGE_URL; // Replace PAGE_URL with your page's canonical URL variable
+ this.page.identifier = "#{ id }"; // Replace PAGE_IDENTIFIER with your page's unique identifier variable
+ };
+ */
+ (function() { // DON'T EDIT BELOW THIS LINE
+ var d = document, s = d.createElement('script');
+ s.src = 'https://misskey.disqus.com/embed.js';
+ s.setAttribute('data-timestamp', +new Date());
+ (d.head || d.body).appendChild(s);
+ })();
+ </script>
+ <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+
footer
block footer
small= copyright
diff --git a/src/docs/style.styl b/src/docs/style.styl
index 5caa65cedd..b01fe493ac 100644
--- a/src/docs/style.styl
+++ b/src/docs/style.styl
@@ -40,7 +40,12 @@ main
border none
border-bottom solid 2px #eee
- footer
+ > aside
+ margin-top 32px
+ padding-top 32px
+ border-top solid 2px #eee
+
+ > footer
margin 32px 0 0 0
border-top solid 2px #eee
diff --git a/src/server/web/docs.ts b/src/server/web/docs.ts
index f0181c4b94..81e5ace3e8 100644
--- a/src/server/web/docs.ts
+++ b/src/server/web/docs.ts
@@ -173,9 +173,10 @@ router.get('/*/api/endpoints/*', async ctx => {
const ep = endpoints.find(e => e.name === name);
const vars = {
+ id: `api/endpoints/${name}`,
title: name,
endpoint: ep.meta,
- url: {
+ endpointUrl: {
host: config.api_url,
path: name
},
@@ -198,6 +199,7 @@ router.get('/*/api/entities/*', async ctx => {
const x = yaml.safeLoad(fs.readFileSync(path.resolve(__dirname + '/../../../src/docs/api/entities/' + entity + '.yaml'), 'utf-8')) as any;
await ctx.render('../../../../src/docs/api/entities/view', Object.assign(await genVars(lang), {
+ id: `api/entities/${entity}`,
name: x.name,
desc: x.desc,
props: sortParams(Object.entries(x.props).map(([k, v]) => parsePropDefinition(k, v))),
@@ -228,6 +230,7 @@ router.get('/*/*', async ctx => {
const md = fs.readFileSync(`${__dirname}/../../../src/docs/${doc}.${lang}.md`, 'utf8');
await ctx.render('../../../../src/docs/article', Object.assign({
+ id: doc,
html: conv.makeHtml(md),
title: md.match(/^# (.+?)\r?\n/)[1],
src: `https://github.com/syuilo/misskey/tree/master/src/docs/${doc}.${lang}.md`