search

tcmulder / aquamin

Aquamin WordPress Theme
3 stars 1 forks source link

Consider switching to Markdoc (or similar framework) so everything’s in Node, not ruby. #45

Closed tcmulder closed 1 year ago

tcmulder commented 1 year ago

Markdoc

tcmulder commented 1 year ago

Or, consider Docsify (with GitHub pages), or even a Gatsby theme (with GitHub pages).

The advantage of Mardoc is that it's node; the advantage of Docsify is that it has a GitHub Pages action already set up for it; the advantage of Gatsby is it should be possible to generate browsable HTML docs, though only via a working server.

tcmulder commented 1 year ago

Or, Docusaurus (with GitHub pages). It's more React-based.

tcmulder commented 1 year ago

Which of these would allow me to either 1) simply generate static HTML that can be used without a special server, or at least 2) make it easy to run e.g. npm run docs which would do like npm run some-doc-command && open http://localhost:1234/some-doc-commands-built-in-server so people can still easily access the docs without going to GitHub?