Document Generator
Document Generator
- Currently using facebook docusaurus to create static site for markdown files. More about docusaurus in 'learning -> misc -> Document Generator'
- Change single large build to small product independent build management
- host their documentation in our server, also commit build in their repo to provide self hosting option.
Custom Doc Generator module
Create an Aurelia Single page application (SPA)
load all markdown files at runtime using custom element.
In custom element - By fetch load md file, use marked library to parse md file text to html text, bind that html to DOM.
Given an edit icon, click on which navigate to GITHUB for direct file modification.
Left side nav bar must be auto generated from folder structure of md files
During build process, use node lib to generate folder structure to json file. Use that json file to create left navbar.
multiple navbar files can be in folder, let user choose from dropdown to load navbar type.
Add elastic search for document search
- do as a product where it looks for files modified by meta data & indexes automatically. When you query - just pass search keyword & absolute disk file path. elasticsearch markdown analyzer
If not elastic search, For slick docs use mongodb atlas free tier for indexing (as it has lucene in cloud)
Give an UI/ button in same product to apply build, pull changes..etc
Later add Login Page for authentication in public API/ mobile view.
Target documentation
- ISO docs
- HR docs
- TW help manuals & JAVA docs
- Mobility docs & help manuals