mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-11-08 22:13:08 +02:00
Improve doc
This commit is contained in:
parent
fff3c552e2
commit
5bb619fe7b
3 changed files with 26 additions and 6 deletions
|
@ -1 +1,8 @@
|
|||
see [releases](https://github.com/misskey-dev/misskey/releases)
|
||||
## 12.86.0 (unreleased)
|
||||
|
||||
### Improvements
|
||||
- ドキュメントにchangelogを追加
|
||||
- Vueを3.2.1に更新
|
||||
|
||||
### Bugfixes
|
||||
- ハッシュタグ入力が空のときに#が付くのを修正
|
||||
|
|
5
src/docs/ja-JP/general/changelog.md
Normal file
5
src/docs/ja-JP/general/changelog.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
# 更新履歴
|
||||
<div class="info">ℹ️ このサーバーの更新履歴です。Misskeyの最新のリリースについては、<a href="https://github.com/misskey-dev/misskey/blob/master/CHANGELOG.md" target="_blank">GitHub</a>をご確認ください。</div>
|
||||
|
||||
<!-- For translators: Do not edit these comments. -->
|
||||
<!--[CHANGELOG]-->
|
|
@ -28,6 +28,13 @@ const markdown = MarkdownIt({
|
|||
html: true
|
||||
});
|
||||
|
||||
const changelog = fs.readFileSync(`${__dirname}/../../../CHANGELOG.md`, { encoding: 'utf8' });
|
||||
function genDoc(path: string): string {
|
||||
let md = fs.readFileSync(path, { encoding: 'utf8' });
|
||||
md = md.replace('<!--[CHANGELOG]-->', changelog);
|
||||
return md;
|
||||
}
|
||||
|
||||
const staticAssets = `${__dirname}/../../../assets/`;
|
||||
const docAssets = `${__dirname}/../../../src/docs/`;
|
||||
const assets = `${__dirname}/../../assets/`;
|
||||
|
@ -67,10 +74,11 @@ router.get('/static-assets/(.*)', async ctx => {
|
|||
});
|
||||
|
||||
router.get('/doc-assets/(.*)', async ctx => {
|
||||
await send(ctx as any, ctx.path.replace('/doc-assets/', ''), {
|
||||
root: docAssets,
|
||||
maxage: ms('7 days'),
|
||||
});
|
||||
if (ctx.path.includes('..')) return;
|
||||
const path = `${__dirname}/../../../src/docs/${ctx.path.replace('/doc-assets/', '')}`;
|
||||
const doc = genDoc(path);
|
||||
ctx.set('Content-Type', 'text/plain; charset=utf-8');
|
||||
ctx.body = doc;
|
||||
});
|
||||
|
||||
router.get('/assets/(.*)', async ctx => {
|
||||
|
@ -130,7 +138,7 @@ router.get('/docs.json', async ctx => {
|
|||
const paths = glob.sync(`${dirPath}/**/*.md`);
|
||||
const docs: { path: string; title: string; summary: string; }[] = [];
|
||||
for (const path of paths) {
|
||||
const md = fs.readFileSync(path, { encoding: 'utf8' });
|
||||
const md = genDoc(path);
|
||||
|
||||
if (query && query.length > 0) {
|
||||
// TODO: カタカナをひらがなにして比較するなどしたい
|
||||
|
|
Loading…
Reference in a new issue