React-Typescript documentation app styled with Material UI and parsing/rendering markdown files with dandy-doc library.
- Documentation site viewable here: https://jocelynmutso.github.io/documentation-test/
- dandy-doc library repo: https://github.com/jocelynmutso/dandy-doc
- branch: master
yarn buildyarn run deploy
The left menu is populated by Topics and their Subtopics.
Currrently, this menu system supports nesting up to TWO levels deep. This means that there can be a Topic and its Subtopic, but there can not be a Sub-subtopic.
Topic: A folder name. The left menu is populated by rendering Folder names as Topics; i.e., the names of your folders which contain your Markdown files will be rendered as Topic names in the left menu.
Subtopic: A Markdown file name. The left menu renders Markdown file names as subtopics.
- Capitalisation: Topic and file names do not need to be capitalised. They will automatically be capitalised by dandy-doc.
- Spaces: Use an underscore to create spaces between words in topic and Markdown file names. Dandy-doc will automatically replace them with empty strings upon rendering.
- Use of underscores: Topic and subtopic names can not begin with an underscore. This can cause build failure.
- Ordering: To ensure your items are arranged in the desired order, give each topic and subtopic a numeric ordering prefix. See next section for these rules.
Example of good Topic (Folder) naming:
045_basic_functionalities002_overview_of_features
Examples of good Subtopic (Markdown file) naming:
003_use_of_tag_feature.md005_troubleshooting.md
- Topic and subtopic names may be given numeric prefixes for ordering purposes
- The format for a prefix is three digits, followed by an underscore.
Example:
Prefix: 003_
Prefix applied to a markdown file: 003_my_best_topic.md
- In a topic name, using colons is supported
- In a subtopic name, using colons will cause build failure
Example:
Topic name: 003_advanced_functionality:_setting_ids --> This will work fine, as it is a topic name
Subtopic name: 109_setting_ids:_first_steps.md --> This will cause build failure, because this markdown file name includes a colon.
To solve this problem, simply remove the colon from the markdown file name.
Page link:
Page link with anchor:
TODO
TODO