Portable Wiki (pWiki)
NOTE: the project is currently in prototype phase, thus while most things are likely to change, the implementation / API will definitely change! ;)
Project goals / main features:
-
Simple embeddable Wiki
To be used as a zero-workflow app documentation platform, 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 and as a side-effect pWiki hosts it's own documentation too.
-
Pluggable storage and synchronization mechanisms
A set of tools and API's to enable data synchronization between pWiki instances.
-
Self-hosted[*] and flexible user interface
The pWiki interface is implemented as a set of pWiki pages and templates within pWiki itself (see: [Templates] / /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.
[*]: "Self-hosted" here is meant in the old-school meaning of the word, i.e. hosted on the client.
-
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.
The app serves the following goals:
- a simple and functional note / todo / outline app (obviously)
- an external/portable Wiki editor, as an alternative for in-target-app documentation editor with ability to seamlesly synchronize with the target app pWiki instance.
- a stand-alone testing platform and reference implementation for pWiki components.
General Documentation:
- General info - This document.
- Bootstrap path - Path mechanics.
- Bootstrap macros - Macro documentation
Project:
- The project on GitHub
- pWiki live demo (hosted on Gitgub) – The data is stored in sessionStorage on the client, closing the tab/browser will reset the wiki.
License and Copyright
pWiki is developed by Alex A. Naanou and licensed under the 3-Clause BSD License