self-hosted/pigallery2
1
0
Fork 0
mirror of https://github.com/bpatrik/pigallery2.git synced 2026-06-20 00:15:49 +02:00
Code Issues Releases Activity

improving settings documentation

Browse Source
This commit is contained in:
Patrik J. Braun
2020-02-07 13:59:36 +01:00
parent c13e90dca6
commit c6c4210dd2
5 changed files with 235 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
gulpfile.ts
+6 -2
View File
@@ -10,7 +10,7 @@ import * as child_process from 'child_process';
// @ts-ignore
import * as jeditor from 'gulp-json-editor';
import {XLIFF} from 'xlf-google-translate';
import {Config} from './src/common/config/private/Config';
import {Config, PrivateConfigClass} from './src/common/config/private/Config';
import {ConfigClassBuilder} from 'typeconfig/src/decorators/builders/ConfigClassBuilder';
const execPr = util.promisify(child_process.exec);
@@ -345,10 +345,14 @@ gulp.task('add-translation-only', (cb) => {
});
gulp.task('generate-man', async (cb) => {
const defCFG = ConfigClassBuilder.attachInterface(new PrivateConfigClass());
defCFG.Server.sessionSecret = [];
let txt = '# Pigallery 2 man page\n';
txt += 'pigallery2 uses [typeconfig](https://github.com/bpatrik/typeconfig) for configuration\n\n';
txt += '`npm start -- --help` prints the following:\n\n';
txt += '```\n' + ConfigClassBuilder.attachPrivateInterface(Config).__printMan() + '```';
txt += '```\n' + ConfigClassBuilder.attachPrivateInterface(defCFG).__printMan() + '```';
txt += '\n\n ### `config.json` sample:\n';
txt += '```json\n' + JSON.stringify(defCFG, null, 4) + '```';
await fsp.writeFile('MANPAGE.md', txt);
cb();
});