e-wiki
Sets up one or more static wikis via Express.
Install
Execute the following command from your project folder, where your package.json
file is stored:
npm install --save e-wiki
Example
Quick start
Setup UI
;; ; // create a '/wiki' endpoint ...setupWiki , // directly register it in 'app' app; app.listen8080,;
Create first page
Create a index.md
inside the root of your wiki folder and fill it with Markdown content.
You should now be able to access the (start) page with /
url.
You also be able to define a directory structure and store any kind of files, like images or videos, which are handled like on a static HTTP server.
Charts and diagrams
Markdown pages can also include diagrams and charts, using a language parsed and rendered by mermaid.
Those have to be put into a code block, which uses mermaid
as language:
Example graph:
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
Documentation
API documentation can be found here.
Resources
Copyright
That software makes use of free version of MD Bootstrap.