README.md

MDoc

Is a single page markdown explorer (see example), inspired by the no longer maintained MDwiki

How to use

1. Copy the index.html from the dist folder to the root of your Markdown folder
2. (Optional) Create and configure a settings.json file (see dist/settings.json)
3. (Optional) For File-tree and Search functionality - Run the dist/Create-ContentJson.ps1 file during your build process this creates a content.json file and place this in the Markdown folder root.
4. Try pressing CTRL+SHIFT+A to engage 'admin mode', for theme selection and displaying all files under a folder.

no jQuery

Try not using jQuery and code VanillaJS, see Sans jQuery

Credits

• Original MDWiki - Site
• Favicon - Markdown Here

Task list

• Write documentation about the settings.json
• Write documentation about this repo (see template)

Task list done

• Add npm run command to make development easy (eg watch files and transpile?!)
• Add warning for <= IE11 when rendering Mermaid
• Page not found/error handling
• Page loading between pages
• Table striped styling
• Fullscreen viewing (mermaid, tables)
• Table Of Contents links
• Make the top nav sticky (or create different navigation)
• Support Bootswatch themes
• Add Git edit and history links
• Integrate PlantUML
• Create build for one html file
• Transpile inline js
• Add print style sheet
• Add favicon
• Add theming (see Bootswatch)
• Add highlighting of current ToC item