natty
/
misskey-awawa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

✌️

This commit is contained in:
syuilo 2017-12-15 06:41:57 +09:00
parent 5725e39a70
commit 169b99a358
12 changed files with 220 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
gulpfile.ts
View File

@ -13,7 +13,6 @@ import * as es from 'event-stream';
import cssnano = require('gulp-cssnano');
import * as uglifyComposer from 'gulp-uglify/composer';
import pug = require('gulp-pug');
import stylus = require('gulp-stylus');
import * as rimraf from 'rimraf';
import chalk from 'chalk';
import imagemin = require('gulp-imagemin');
@ -48,32 +47,18 @@ if (isDebug) {
const constants = require('./src/const.json');
require('./src/web/docs/api/gulpfile.ts');
require('./src/web/docs/gulpfile.ts');
gulp.task('build', [
'build:js',
'build:ts',
'build:copy',
'build:client',
'build:doc'
'doc'
]);
gulp.task('rebuild', ['clean', 'build']);
gulp.task('build:doc', [
'doc:api',
'doc:styles'
]);
gulp.task('doc:styles', () =>
gulp.src('./src/web/docs/**/*.styl')
.pipe(stylus())
.pipe(isProduction
? (cssnano as any)()
: gutil.noop())
.pipe(gulp.dest('./built/web/assets/docs/'))
);
gulp.task('build:js', () =>
gulp.src(['./src/**/*.js', '!./src/web/**/*.js'])
.pipe(gulp.dest('./built/'))

3
src/web/docs/api/endpoints/view.pug
View File

@ -12,7 +12,7 @@ block main
p#url= url
p#desc: +i18n(desc)
p#desc= desc[lang] || desc['ja']
section
h2 Params
@ -27,4 +27,3 @@ block main
section
h2 Response
+propTable(res)

2
src/web/docs/api/entities/view.pug
View File

@ -10,7 +10,7 @@ block meta
block main
h1= name
p#desc: +i18n(desc)
p#desc= desc[lang] || desc['ja']
section
h2 Properties

28
src/web/docs/api/gulpfile.ts
View File

@ -12,6 +12,12 @@ import * as mkdirp from 'mkdirp';
import config from './../../../conf';
import generateVars from '../vars';
const commonVars = generateVars();
const langs = ['ja', 'en'];
const kebab = string => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
const parseParam = param => {
@ -102,14 +108,18 @@ gulp.task('doc:api:endpoints', () => {
paramDefs: extractDefs(ep.params),
res: sortParams(ep.res.map(p => parseParam(p))),
resDefs: extractDefs(ep.res),
kebab
kebab,
common: commonVars
};
pug.renderFile('./src/web/docs/api/endpoints/view.pug', vars, (renderErr, html) => {
langs.forEach(lang => {
pug.renderFile('./src/web/docs/api/endpoints/view.pug', Object.assign({}, vars, {
lang
}), (renderErr, html) => {
if (renderErr) {
console.error(renderErr);
return;
}
const htmlPath = `./built/web/docs/api/endpoints/${ep.endpoint}.html`;
const htmlPath = `./built/web/docs/${lang}/api/endpoints/${ep.endpoint}.html`;
mkdirp(path.dirname(htmlPath), (mkdirErr) => {
if (mkdirErr) {
console.error(mkdirErr);
@ -120,6 +130,7 @@ gulp.task('doc:api:endpoints', () => {
});
});
});
});
});
gulp.task('doc:api:entities', () => {
@ -135,14 +146,18 @@ gulp.task('doc:api:entities', () => {
desc: entity.desc,
props: sortParams(entity.props.map(p => parseParam(p))),
propDefs: extractDefs(entity.props),
kebab
kebab,
common: commonVars
};
pug.renderFile('./src/web/docs/api/entities/view.pug', vars, (renderErr, html) => {
langs.forEach(lang => {
pug.renderFile('./src/web/docs/api/entities/view.pug', Object.assign({}, vars, {
lang
}), (renderErr, html) => {
if (renderErr) {
console.error(renderErr);
return;
}
const htmlPath = `./built/web/docs/api/entities/${kebab(entity.name)}.html`;
const htmlPath = `./built/web/docs/${lang}/api/entities/${kebab(entity.name)}.html`;
mkdirp(path.dirname(htmlPath), (mkdirErr) => {
if (mkdirErr) {
console.error(mkdirErr);
@ -153,4 +168,5 @@ gulp.task('doc:api:entities', () => {
});
});
});
});
});

6
src/web/docs/api/mixins.pug
View File

@ -14,13 +14,13 @@ mixin propTable(props)
if prop.kind == 'id'
if prop.entity
| (
a(href=`/docs/api/entities/${kebab(prop.entity)}`)= prop.entity
a(href=`/docs/${lang}/api/entities/${kebab(prop.entity)}`)= prop.entity
| ID)
else
| (ID)
else if prop.kind == 'entity'
| (
a(href=`/docs/api/entities/${kebab(prop.entity)}`)= prop.entity
a(href=`/docs/${lang}/api/entities/${kebab(prop.entity)}`)= prop.entity
| )
else if prop.kind == 'object'
if prop.def
@ -30,4 +30,4 @@ mixin propTable(props)
else if prop.kind == 'date'
| (Date)
td.optional= prop.optional.toString()
td.desc: +i18n(prop.desc)
td.desc!= prop.desc[lang] || prop.desc['ja']

64
src/web/docs/gulpfile.ts Normal file
View File

@ -0,0 +1,64 @@
/**
* Gulp tasks
*/
import * as fs from 'fs';
import * as path from 'path';
import * as glob from 'glob';
import * as gulp from 'gulp';
import * as pug from 'pug';
//import * as yaml from 'js-yaml';
import * as mkdirp from 'mkdirp';
import stylus = require('gulp-stylus');
import cssnano = require('gulp-cssnano');
//import config from './../../conf';
import generateVars from './vars';
require('./api/gulpfile.ts');
gulp.task('doc', [
'doc:docs',
'doc:api',
'doc:styles'
]);
const commonVars = generateVars();
gulp.task('doc:docs', () => {
glob('./src/web/docs/**/*.*.pug', (globErr, files) => {
if (globErr) {
console.error(globErr);
return;
}
files.forEach(file => {
const [, name, lang] = file.match(/docs\/(.+?)\.(.+?)\.pug$/);
const vars = {
common: commonVars,
lang: lang
};
pug.renderFile(file, vars, (renderErr, html) => {
if (renderErr) {
console.error(renderErr);
return;
}
const htmlPath = `./built/web/docs/${lang}/${name}.html`;
mkdirp(path.dirname(htmlPath), (mkdirErr) => {
if (mkdirErr) {
console.error(mkdirErr);
return;
}
fs.writeFileSync(htmlPath, html, 'utf-8');
});
});
});
});
});
gulp.task('doc:styles', () =>
gulp.src('./src/web/docs/**/*.styl')
.pipe(stylus())
.pipe((cssnano as any)())
.pipe(gulp.dest('./built/web/assets/docs/'))
);

9
src/web/docs/index.en.pug Normal file
View File

@ -0,0 +1,9 @@
extends ./layout.pug
block title
| Misskey Docs
block main
h1 Misskey Docs
p Welcome to docs of Misskey.

9
src/web/docs/index.ja.pug Normal file
View File

@ -0,0 +1,9 @@
extends ./layout.pug
block title
| Misskey ドキュメント
block main
h1 Misskey ドキュメント
p Misskeyのドキュメントへようこそ

4
src/web/docs/index.md
View File

@ -1,4 +0,0 @@
Misskeyについて
================================================================
誰か書いて

23
src/web/docs/layout.pug
View File

@ -1,16 +1,29 @@
doctype html
mixin i18n(xs)
each text, lang in xs
span(class=`i18n ${lang}`)!= text
html
html(lang= lang)
head
meta(charset="UTF-8")
meta(name="viewport" content="width=device-width,initial-scale=1,minimum-scale=1,maximum-scale=1,user-scalable=no")
title
block title
link(rel="stylesheet" href="/assets/docs/style.css")
block meta
body
nav
ul
each doc in common.docs
li: a(href=`/docs/${lang}/${doc.name}`)= doc.title[lang] || doc.title['ja']
section
h2 API
ul
li Entities
ul
each entity in common.entities
li: a(href=`/docs/${lang}/api/entities/${common.kebab(entity)}`)= entity
li Endpoints
ul
each endpoint in common.endpoints
li: a(href=`/docs/${lang}/api/endpoints/${common.kebab(endpoint)}`)= endpoint
main
block main

69
src/web/docs/style.styl
View File

@ -5,10 +5,49 @@ body
color #34495e
main
margin 0 0 0 256px
padding 32px
width 100%
max-width 700px
section
margin 32px 0
h1
margin 0 0 24px 0
padding 16px 0
font-size 1.5em
border-bottom solid 2px #eee
h2
margin 0 0 24px 0
padding 0 0 16px 0
font-size 1.4em
border-bottom solid 1px #eee
h3
margin 0
padding 0
font-size 1.25em
h4
margin 0
p
margin 1em 0
line-height 1.6em
nav
display block
position fixed
top 0
left 0
width 256px
height 100%
overflow auto
padding 32px
border-right solid 2px #eee
footer
padding:32px 0 0 0
margin 32px 0 0 0
@ -18,33 +57,6 @@ footer
margin 16px 0 0 0
color #aaa
section
margin 32px 0
h1
margin 0 0 24px 0
padding 16px 0
font-size 1.5em
border-bottom solid 2px #eee
h2
margin 0 0 24px 0
padding 0 0 16px 0
font-size 1.4em
border-bottom solid 1px #eee
h3
margin 0
padding 0
font-size 1.25em
h4
margin 0
p
margin 1em 0
line-height 1.6em
table
width 100%
border-spacing 0
@ -72,6 +84,3 @@ table
th, td
padding 8px 16px
.i18n:not(.ja)
display none

36
src/web/docs/vars.ts Normal file
View File

@ -0,0 +1,36 @@
import * as fs from 'fs';
import * as glob from 'glob';
import * as yaml from 'js-yaml';
export default function() {
const vars = {};
const endpoints = glob.sync('./src/web/docs/api/endpoints/**/*.yaml');
vars['endpoints'] = endpoints.map(ep => {
const _ep = yaml.safeLoad(fs.readFileSync(ep, 'utf-8'));
return _ep.endpoint;
});
const entities = glob.sync('./src/web/docs/api/entities/**/*.yaml');
vars['entities'] = entities.map(x => {
const _x = yaml.safeLoad(fs.readFileSync(x, 'utf-8'));
return _x.name;
});
const docs = glob.sync('./src/web/docs/**/*.*.pug');
vars['docs'] = {};
docs.forEach(x => {
const [, name, lang] = x.match(/docs\/(.+?)\.(.+?)\.pug$/);
if (vars['docs'][name] == null) {
vars['docs'][name] = {
name,
title: {}
};
}
vars['docs'][name]['title'][lang] = fs.readFileSync(x, 'utf-8').match(/\r\n\th1 (.+?)\r\n/)[1];
});
vars['kebab'] = string => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
return vars;
}