I read this as 'Nanosaurus 2' beta and memories came flooding back of struggling to control a flying velociraptor with a mouse as one of my first experiences ever with a game on OSX in the Apple Stores.
Docusaurus 2 Beta
31–40 of 61 posts
Re: Docusaurus 2 Beta
#32Any chance for AsciiDoctor support?
Looks like there is a feature request for it here[1].
I would personally love asciidoc support too. Here's hoping.
[1]: https://docusaurus.canny.io/feature-requests/p/asciidoc-supp...
Re: Docusaurus 2 Beta
#33Earlier quoted context omitted.
How does it compare with say, mdbook?
Some good info here: https://docusaurus.io/docs/#comparison-with-other-tools It's the same general wheelhouse of documentation tools as mdbook, i.e. take a pile of markdown and produce high quality documentation. One of the standout features of Docusaurus is that it's based on React so it builds a SPA for your documentation (while still being good about pre-rendering, etc. for good SEO). If you load up a Docusaurus s…
It'd be great if the Docusaurus team added mdBook and Bookdown to their comparison, with an emphasis on code example execution or including code from larger programs. I find that feature of mdBook invaluable (its marker-approach makes documenting how a library works very easy, and keeps the code examples up-to-date as the library evolves) and Bookdown's include code & its output is also good.
Just a shame one package doesn't include every one of these features.
Re: Docusaurus 2 Beta
#34Oh sweet, it's the first time I work on something and someone else post the link to Hacker News :D
This looks interesting! In the past, I've been a big fan of automatic documentation generators (jsdoc, openapi, etc), because keeping a markdown file full of function names and arguments up to date by hand was painful- but I don't like that those systems have little room for prose content like guides or tutorials. Does Docusaurus support both types of information? The examples I've browsed so far seem to involve hand…
Combining TypeScript's API Extractor (Microsoft) with Docusaurus is great.
You can mix guides/tutorials with generated API docs.
For example, I really like having simple API docs in the `readme.md` file, but then also in-depth docs elsewhere.
MDX + remark really let you do anything you want. It's the ultimate documentation stack.
Re: Docusaurus 2 Beta
#35I recently ported some docs to docusaurus, love it. Wish it had a builtin search indexer so it didn't need to jump out to another site for that.
Yeh this is missing right now.
I'd love a search indexer that runs locally and incrementally, so that I can search without building/publishing.
Re: Docusaurus 2 Beta
#36Earlier quoted context omitted.
thanks for all your hard work on Docusaurus!! happy users here https://docs.temporal.io/ (and of course, https://react-typescript-cheatsheet.netlify.app/ haha) right now probably my biggest pain point is the mobile nav. i know acemarke already raised the thing about desktop right-panel subheadings disappearing on mobile, but for me the bottom right Floating Action Button menu is not intuitive for most people. i dont…
Thanks! Yes we agree on that. Something I'll try to fix asap
i know theres a chance i dont have enough context on how to fix it but if its a react or design problem i would be interested to pitch in.. regardless thank you for stepping up to maintain docusaurus!
Re: Docusaurus 2 Beta
#37I 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…
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
Re: Docusaurus 2 Beta
#38I wanted to love Docusaurus because I'm more of a React guy and I like MDX, but I think Vuepress is better for writing a good documentation.
Something in Docusaurus feels off. When you install it, you're not ready to go, there are a lot of things to clean and remove because it seems to be very tied to Facebook's use.
Maybe it's just me though.
Re: Docusaurus 2 Beta
#39What is Docusaurus? It is not very clear from the announcement nor from docusaurus’ homepage. Would love an explanation from someone who uses it. Thank you.
It is a simple markdown-and-folder-structure based react app with PRPL that increasingly powers most of the high quality docs pages you see. For example: https://developers.cloudflare.com/ https://reactnative.dev/docs/getting-started more: https://docusaurus.io/showcase/
Excellent short answer. What's PRPL? (Google tells me it's a furniture company or an embedded systems foundation, neither of which make sense in this context)
Re: Docusaurus 2 Beta
#40I recently ported some docs to docusaurus, love it. Wish it had a builtin search indexer so it didn't need to jump out to another site for that.
Have you seen the community plugins - https://docusaurus.io/community/resources/#community-plugins. There are some search options there that may be of use to you.