pWiki/README.md
Alex A. Naanou dd98496831 updated readme...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2016-08-15 19:07:01 +03:00

1.6 KiB

Portable Wiki (pWiki)

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: /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

    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: