pWiki/README.md

32 lines
950 B
Markdown
Raw Normal View History

# Portable Wiki (pWiki)
### Project goals / main features:
- _Simple embeddable Wiki_
This enables a zero-workflow app documentation, i.e. documentation that
can be created, edited, tweaked and updated in-app without requiring
setting up and maintaining a write-convert-embed workflow.
This was a requirement on the _ImageGrid.Viewer_ project.
- _Pluggable storage and synchronization_ mechanisms
- _Self-hosted_ and flexible user interface
- Wiki/note _portable app_
- a simple and functional note/todo/outline app
- an external/portable Wiki editor, as an alternative for in-app
documentation editor with ability to seamlesly synchronize with
the target app.
- a stand-alone testing platform for project components
### General Documentation:
- WikiPath / [bootstrap](bootstrap/WikiPath.md)
- WikiMacros / [bootstrap](bootstrap/WikiMacros.md)
<!-- @filter(markdown) -->
<!-- vim:set ts=4 sw=4 spell -->