Hacker News new | ask | show | jobs
by tony 1867 days ago
I moved from 11ty / eleventy to docusaurus here: https://social-embed.git-pull.com/

Pluses:

- Very active project

- Nice theme out of the box / configuration. Better than any static site generator I've used thus far

- React components / pages

- Configurability, both by settings, plugins. I was able to add a (non-react) custom element to the static build output

- The sidebar, which supports nesting

- Table of contents on the right side. Highlights current section + supports nesting

- Algolia search adds a ton of value. There's a plugin for it: https://docusaurus.io/docs/search

- Dark / light mode

- Can sorta host API docs, if you can generate Markdown for your API, docusaurus can show it: https://social-embed.git-pull.com/docs/lib/api, https://social-embed.git-pull.com/docs/wc/api/classes/oembed...

- Supports namespacing between releases (e.g. v1.1, v1.2) and multiple languages

1 comments

Thanks for the feddback

No drawbacks to share compared to your previous stack?

I inherited 11ty from a boilerplate, but to be fair to them, people do amazing stuff with it: Example https://web.dev/how-we-build-webdev-and-use-web-components/.

Back to docusaurus, one weakness is the lack of API documentation tools. Check to see if the programming language for your project has a docusaurus (or a markdown) API generator.

For Python, if you use docusaurus, there's no API documentation generation is nowhere near Sphinx.

Sphinx uses sphinx.ext.autodoc (https://www.sphinx-doc.org/en/master/usage/extensions/autodo...). The dream would be getting a python API like this ported to docusaurus: https://libtmux.git-pull.com/api.html

This can supposedly do it via exporting the API to markdown: https://github.com/NiklasRosenstein/pydoc-markdown