Can I generate html pages referencing each other from md files

110 Views Asked by At

Can I write documentation in multiple .md files that reference each other and then use a tool like Dillinger to turn all these .md files into multiple html pages referencing each other?

I.e. can I go automatically (using Dillinger or Stackedit or any other software) from

docs/readme.md  (with links to feature1.md and details.md)
docs/features/feature1.md (with link to readme.md)
src/details.md (with link to readme.md)

to

docs/readme.html (with links to feature1.html and details.html)
docs/features/feature1.html (with link to readme.html)
src/details.html (with link to readme.html)

So that I can build and maintain online documentation on a piece of software I write, with the expectation that the user can access the doc by either:

  • reading directly the .md file inserted in my source, or,

  • visualizing on their browser the html documentation I will have generated from the .md files whenever I release/update my software

1

There are 1 best solutions below

0
Lolo On

mkdocs using the use_directory_urls: false option does exactly that when running mkdocs build