52774bbe64
* wip * wip * wip * Update index.ts * Update gen-openapi-spec.ts * Update api.ja-JP.md * Fix * Improve doc * Update gen-openapi-spec.ts * Update redoc.html * Improve doc * Update gen-openapi-spec.ts * Improve doc * Update CHANGELOG.md
108 lines
2.6 KiB
TypeScript
108 lines
2.6 KiB
TypeScript
/**
|
|
* Docs
|
|
*/
|
|
|
|
import * as fs from 'fs';
|
|
import * as path from 'path';
|
|
import * as showdown from 'showdown';
|
|
import 'showdown-highlightjs-extension';
|
|
import ms = require('ms');
|
|
import * as Router from 'koa-router';
|
|
import * as send from 'koa-send';
|
|
import * as glob from 'glob';
|
|
import config from '../../config';
|
|
import { licenseHtml } from '../../misc/license';
|
|
import { copyright } from '../../const.json';
|
|
import * as locales from '../../../locales';
|
|
import * as nestedProperty from 'nested-property';
|
|
|
|
function getLang(lang: string): string {
|
|
if (['en-US', 'ja-JP'].includes(lang)) {
|
|
return lang;
|
|
} else {
|
|
return 'en-US';
|
|
}
|
|
}
|
|
|
|
async function genVars(lang: string): Promise<{ [key: string]: any }> {
|
|
const vars = {} as { [key: string]: any };
|
|
|
|
vars['lang'] = lang;
|
|
|
|
const cwd = path.resolve(__dirname + '/../../../') + '/';
|
|
|
|
const docs = glob.sync(`src/docs/**/*.${lang}.md`, { cwd });
|
|
vars['docs'] = {};
|
|
for (const x of docs) {
|
|
const [, name] = x.match(/docs\/(.+?)\.(.+?)\.md$/);
|
|
if (vars['docs'][name] == null) {
|
|
vars['docs'][name] = {
|
|
name,
|
|
title: {}
|
|
};
|
|
}
|
|
vars['docs'][name]['title'][lang] = fs.readFileSync(cwd + x, 'utf-8').match(/^# (.+?)\r?\n/)[1];
|
|
}
|
|
|
|
vars['kebab'] = (string: string) => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
|
|
|
|
vars['config'] = config;
|
|
|
|
vars['copyright'] = copyright;
|
|
|
|
vars['license'] = licenseHtml;
|
|
|
|
vars['i18n'] = (key: string) => nestedProperty.get(locales[lang], key);
|
|
|
|
return vars;
|
|
}
|
|
|
|
const router = new Router();
|
|
|
|
router.get('/assets/*', async ctx => {
|
|
await send(ctx as any, ctx.params[0], {
|
|
root: `${__dirname}/../../docs/assets/`,
|
|
maxage: ms('1 days')
|
|
});
|
|
});
|
|
|
|
router.get('/*/*', async ctx => {
|
|
const lang = getLang(ctx.params[0]);
|
|
const doc = ctx.params[1];
|
|
|
|
showdown.extension('urlExtension', () => ({
|
|
type: 'output',
|
|
regex: /%URL%/g,
|
|
replace: config.url
|
|
}));
|
|
|
|
showdown.extension('wsUrlExtension', () => ({
|
|
type: 'output',
|
|
regex: /%WS_URL%/g,
|
|
replace: config.ws_url
|
|
}));
|
|
|
|
showdown.extension('apiUrlExtension', () => ({
|
|
type: 'output',
|
|
regex: /%API_URL%/g,
|
|
replace: config.api_url
|
|
}));
|
|
|
|
const conv = new showdown.Converter({
|
|
tables: true,
|
|
extensions: ['urlExtension', 'apiUrlExtension', 'highlightjs']
|
|
});
|
|
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`
|
|
}, await genVars(lang)));
|
|
|
|
ctx.set('Cache-Control', 'public, max-age=300');
|
|
});
|
|
|
|
export default router;
|