posthtml / htmlnano

Modular HTML minifier, built on top of the PostHTML

Home Page:https://htmlnano.netlify.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Better docs navigation

maltsev opened this issue · comments

All docs are stored in one README.md which makes navigation tricky. It'd become even worse once we implement different interfaces (e.g., webpack, rollup, CLI).

Possible solutions:

  • Generate a table of contents and append it to README.md
  • Use Github wiki
  • Use Github pages (+ Jekyll?)

Also, it'd be good if the docs for the currently published version of htmlnano are shown by default (not the master branch) to avoid confusion when some feature is implemented but not published to npm yet.

I decided to use docusaurus + Netlify. @Scrum can you please approve Netlify access to the posthtml org?

I decided to use docusaurus + Netlify. @Scrum can you please approve Netlify access to the posthtml org?

done

@Scrum can you please set it as the repo website?

@Scrum can you please set it as the repo website?

done