Closed masteroleary closed 6 years ago
Is there any standard format or example apps of the "index file"?
No. This is a function I have not seen before but have been hoping that any of these markdown viewers/editors would implement it instead of simply opening the "index" page for you to click to the next page. Having the index on the left as a list of links would be fantastic for quick documentation in a project.
I wrote the example above for brevity but now thinking further on it, just having a list of hyper links written in markdown is really the way to do it. For example:
[Read Me](readme.md)
[Setting up the project](setup.md)
[Technologies](/docs/tech.md)
[SQL](/docs/sql.md)
This editor is based on html, not a notebook app like OneNote. I'm sorry that I would not add this function now.
It would be especially nice to work on project documentation with markdown if the editor was able to load an index of multiple MD files on the left and which ever was selected would appear for editing in the right pane.
The index file could be index.md with contents like:
Your app would then load a list of pages in a small vertical pane on the left showing the text of each entry if text was provided at all.