refactoring the docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2016-08-15 19:24:58 +03:00
parent dd98496831
commit 1515c845cf
5 changed files with 24 additions and 14 deletions

View File

@ -20,11 +20,14 @@
- _Self-hosted_ and flexible user interface
The pWiki interface is implemented as a set of pWiki pages and
templates within pWiki itself (see: /bootstrap), this enables the user
to customize the look feel and to some extent the function of the
interface from within pWiki, without touching the code.
templates within pWiki itself (see: [Templates] / [/bootstrap](bootstrap)),
this enables the user to customize the look feel and to some extent
the function of the interface from within pWiki, without touching the
code.
- Wiki/note _portable app_
- pWiki _portable app_
This is a simple note / todo /outline app.
The pWiki app is a stand-alone instance of pWiki wrapped in an app
supporting all major desktop as well as mobile platforms.
@ -40,8 +43,8 @@
### General Documentation:
- WikiPath / [bootstrap](bootstrap/WikiPath.md)
- WikiMacros / [bootstrap](bootstrap/WikiMacros.md)
- WikiPath / [bootstrap](bootstrap/Doc/Path.md)
- WikiMacros / [bootstrap](bootstrap/Doc/Macros.md)
<!-- @filter(markdown) -->

2
bootstrap.js vendored

File diff suppressed because one or more lines are too long

View File

@ -27,17 +27,24 @@ glob('bootstrap/**/*.@(tpl|md|css|html)')
}
})
.on('end', function(){
if(fs.existsSync('README.md')){
console.log('Setting:', 'About')
bootstrap['Doc/About'] = {
text: fs.readFileSync('README.md').toString(),
}
}
if(!bootstrap.WikiHome){
console.log('Setting:', 'WikiHome')
bootstrap.WikiHome = {
text: '@include(Doc/About)'
}
}
var txt = '// This file is generated automatically, '
+'all changes made here will be lost.'
+'\n\n'
+'var Bootstrap = ' + JSON.stringify(bootstrap)
if(!bootstrap.WikiHome && fs.existsSync('README.md')){
bootstrap.WikiHome = {
text: fs.readFileSync('README.md').toString(),
}
}
console.log('Writing:', 'bootstrap.js')
fs.writeFileSync('bootstrap.js', txt)
})