A minimalistic wiki generator that uses markdown files as database and 100% client side rendering.
- Put
index.html
,config.json
andsrc/main.js
in your${project_root}
. - In
${project_root}
directory, create a directory calledcontent/
to put all your markdown files in. - Put your home page in
content/index.md
. - Modify
config.json
to include your navigation links and other settings. Remember to always put#!content/
before all your links inconfig.json
and also in your markdown files to link to your other files. - Serve your root directory using any web server.
- All your content should be inside the
${project_root}/content
folder - Home page will be
${project_root}/content/index.md
- Each folder should have it's own
index.md
file - Underscores (
_
) in folder names will be displayed as spaces in breadcrumbs
project_root
|--index.html
|--config.json
|--src
| |--main.js
|--content
|--index.md
|--Section_1
| |--index.md
| |--Sub-section_1
| | |--index.md
| |--Sub-section_2
| |--index.md
|--Section_2
|--index.md
|--Sub-section_1
|--Very
|--index.md
|--Deep
|--index.md
|--Sub-section
|--index.md
Property | Description | Default value | Example |
---|---|---|---|
title | Title of your wiki | Home | My awesome wiki |
navigation | Links for top navigation bar | {} |
{"Section1": "#!content/Section_1/index.md", "Section 2": "#!content/Section_2/index.md"} |
themeName | Theme name from https://bootswatch.com/ | null |
materia |
themeStyle | Corresponding style for selected theme | primary | light |
https://vaibhav276.github.io/wikigini/
Inspired from MDWiki