Static html export - Githubissues

sinedied / hads

:books: Markdown superpowered documentation for Node.js

MIT License

167 stars 28 forks source link

Static html export #2

Closed sinedied closed 5 years ago

sinedied commented 7 years ago

Add an option to generate static html files from the documentation, like --export <out_folder>

japf commented 7 years ago

That's a must have for the scenario I'm thinking about :-)

If you can provide some guidance about how that should be implemented, I can take a look.

dalgard commented 5 years ago

I haven't been able to find a good zero-config tool for displaying the simple Markdown files in my repo/package that can also compile them into a static HTML site.

In other words, this feature would close a big hole in the tooling landscape for me 🙂

Also – thanks so much for creating this, I absolutely love the idea and the beautiful implementation ✨🙏

ghost commented 5 years ago

I'd like to help with this. @sinedied Do you have any thoughts on how you'd like it done?

sinedied commented 5 years ago

Sorry for the delay!

If you want to get started, a good approach I think would be:

use the list of all doc files available generated for the search index, to go through each one and render it to a file
while rendering to a file, 2 things have to be taken care of:
- disable/hide search bar, as it won't work as it is for static files
- change way markdown generates links to other local files, to add .html suffix to the links

Basically, that should do the trick :)

ghost commented 5 years ago

Great. I'll take a look this weekend.

ghost commented 5 years ago

https://github.com/sinedied/hads/pull/45