Sharkey/src/server/web/docs.ts

108 lines
2.6 KiB
TypeScript
Raw Normal View History

2017-12-16 18:41:22 +02:00
/**
2018-04-13 00:06:18 +03:00
* Docs
2017-12-16 18:41:22 +02:00
*/
2018-07-06 14:27:48 +03:00
import * as fs from 'fs';
import * as path from 'path';
import * as showdown from 'showdown';
2018-07-16 19:11:36 +03:00
import 'showdown-highlightjs-extension';
2018-04-13 06:05:24 +03:00
import ms = require('ms');
2018-04-13 00:06:18 +03:00
import * as Router from 'koa-router';
import * as send from 'koa-send';
2018-07-06 14:27:48 +03:00
import * as glob from 'glob';
2018-07-05 20:58:29 +03:00
import config from '../../config';
2018-07-07 21:13:20 +03:00
import { licenseHtml } from '../../misc/license';
import { copyright } from '../../const.json';
import * as locales from '../../../locales';
import * as nestedProperty from 'nested-property';
2017-12-16 18:41:22 +02:00
2019-02-02 09:16:31 +02:00
function getLang(lang: string): string {
if (['en-US', 'ja-JP'].includes(lang)) {
return lang;
} else {
return 'en-US';
}
}
2018-07-06 14:27:48 +03:00
async function genVars(lang: string): Promise<{ [key: string]: any }> {
const vars = {} as { [key: string]: any };
vars['lang'] = lang;
2018-07-15 13:35:20 +03:00
const cwd = path.resolve(__dirname + '/../../../') + '/';
2018-07-15 13:29:15 +03:00
2018-07-15 16:00:05 +03:00
const docs = glob.sync(`src/docs/**/*.${lang}.md`, { cwd });
2018-07-06 14:27:48 +03:00
vars['docs'] = {};
for (const x of docs) {
2018-07-15 16:00:05 +03:00
const [, name] = x.match(/docs\/(.+?)\.(.+?)\.md$/);
2018-07-06 14:27:48 +03:00
if (vars['docs'][name] == null) {
vars['docs'][name] = {
name,
title: {}
};
}
2018-07-15 13:35:20 +03:00
vars['docs'][name]['title'][lang] = fs.readFileSync(cwd + x, 'utf-8').match(/^# (.+?)\r?\n/)[1];
}
2018-07-06 14:27:48 +03:00
vars['kebab'] = (string: string) => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
vars['config'] = config;
vars['copyright'] = copyright;
2018-07-06 14:27:48 +03:00
vars['license'] = licenseHtml;
2018-11-09 15:02:48 +02:00
vars['i18n'] = (key: string) => nestedProperty.get(locales[lang], key);
2018-07-06 14:27:48 +03:00
return vars;
}
2018-04-13 00:06:18 +03:00
const router = new Router();
2017-12-16 18:41:22 +02:00
2018-04-13 06:05:24 +03:00
router.get('/assets/*', async ctx => {
2019-01-22 14:42:05 +02:00
await send(ctx as any, ctx.params[0], {
root: `${__dirname}/../../docs/assets/`,
2018-09-19 08:22:46 +03:00
maxage: ms('1 days')
2018-04-13 06:05:24 +03:00
});
2018-04-13 00:06:18 +03:00
});
2017-12-16 18:41:22 +02:00
2018-07-06 17:52:47 +03:00
router.get('/*/*', async ctx => {
2019-02-02 09:16:31 +02:00
const lang = getLang(ctx.params[0]);
2018-07-06 17:52:47 +03:00
const doc = ctx.params[1];
2018-07-15 13:05:19 +03:00
showdown.extension('urlExtension', () => ({
type: 'output',
regex: /%URL%/g,
replace: config.url
}));
2018-10-29 12:11:01 +02:00
showdown.extension('wsUrlExtension', () => ({
type: 'output',
regex: /%WS_URL%/g,
replace: config.ws_url
}));
2018-07-15 13:05:19 +03:00
showdown.extension('apiUrlExtension', () => ({
type: 'output',
regex: /%API_URL%/g,
replace: config.api_url
}));
const conv = new showdown.Converter({
tables: true,
2018-07-16 19:11:36 +03:00
extensions: ['urlExtension', 'apiUrlExtension', 'highlightjs']
2018-07-15 13:05:19 +03:00
});
const md = fs.readFileSync(`${__dirname}/../../../src/docs/${doc}.${lang}.md`, 'utf8');
await ctx.render('../../../../src/docs/article', Object.assign({
2018-07-30 10:24:46 +03:00
id: doc,
2018-07-15 15:48:57 +03:00
html: conv.makeHtml(md),
2018-07-16 21:57:34 +03:00
title: md.match(/^# (.+?)\r?\n/)[1],
src: `https://github.com/syuilo/misskey/tree/master/src/docs/${doc}.${lang}.md`
}, await genVars(lang)));
2018-11-19 22:29:51 +02:00
ctx.set('Cache-Control', 'public, max-age=300');
2018-07-06 17:52:47 +03:00
});
2018-04-13 06:05:24 +03:00
export default router;