mirror of
https://github.com/flynx/pWiki.git
synced 2025-10-29 10:00:08 +00:00
refactoring the docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
dd98496831
commit
1515c845cf
17
README.md
17
README.md
@ -20,18 +20,21 @@
|
|||||||
- _Self-hosted_ and flexible user interface
|
- _Self-hosted_ and flexible user interface
|
||||||
|
|
||||||
The pWiki interface is implemented as a set of pWiki pages and
|
The pWiki interface is implemented as a set of pWiki pages and
|
||||||
templates within pWiki itself (see: /bootstrap), this enables the user
|
templates within pWiki itself (see: [Templates] / [/bootstrap](bootstrap)),
|
||||||
to customize the look feel and to some extent the function of the
|
this enables the user to customize the look feel and to some extent
|
||||||
interface from within pWiki, without touching the code.
|
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
|
The pWiki app is a stand-alone instance of pWiki wrapped in an app
|
||||||
supporting all major desktop as well as mobile platforms.
|
supporting all major desktop as well as mobile platforms.
|
||||||
|
|
||||||
The app serves the following goals:
|
The app serves the following goals:
|
||||||
|
|
||||||
- a simple and functional note/todo/outline app (obviously)
|
- a simple and functional note / todo / outline app (obviously)
|
||||||
- an external/portable Wiki editor, as an alternative for
|
- an external/portable Wiki editor, as an alternative for
|
||||||
in-target-app documentation editor with ability to seamlesly
|
in-target-app documentation editor with ability to seamlesly
|
||||||
synchronize with the target app pWiki instance.
|
synchronize with the target app pWiki instance.
|
||||||
@ -40,8 +43,8 @@
|
|||||||
|
|
||||||
|
|
||||||
### General Documentation:
|
### General Documentation:
|
||||||
- WikiPath / [bootstrap](bootstrap/WikiPath.md)
|
- WikiPath / [bootstrap](bootstrap/Doc/Path.md)
|
||||||
- WikiMacros / [bootstrap](bootstrap/WikiMacros.md)
|
- WikiMacros / [bootstrap](bootstrap/Doc/Macros.md)
|
||||||
|
|
||||||
|
|
||||||
<!-- @filter(markdown) -->
|
<!-- @filter(markdown) -->
|
||||||
|
|||||||
2
bootstrap.js
vendored
2
bootstrap.js
vendored
File diff suppressed because one or more lines are too long
@ -27,17 +27,24 @@ glob('bootstrap/**/*.@(tpl|md|css|html)')
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
.on('end', function(){
|
.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, '
|
var txt = '// This file is generated automatically, '
|
||||||
+'all changes made here will be lost.'
|
+'all changes made here will be lost.'
|
||||||
+'\n\n'
|
+'\n\n'
|
||||||
+'var Bootstrap = ' + JSON.stringify(bootstrap)
|
+'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')
|
console.log('Writing:', 'bootstrap.js')
|
||||||
fs.writeFileSync('bootstrap.js', txt)
|
fs.writeFileSync('bootstrap.js', txt)
|
||||||
})
|
})
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user