Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Docusaurus 2 Beta

docusaurus.io

Post reply on HN
Print view View original

21–30 of 61 posts

Re: Docusaurus 2 Beta

#21

Post by slorber »

CraigJPerry wrote: post #10

Just been going through a bunch of docs as code solutions trying to find something i like. I’m troubled by how slow and complicated some build process are. Docusaurus wasn’t the worst offender here although it has more moving parts than i’d like. If you’re still using Sphinx it might be worth a quick scan of the latest tools, the search facilities are quite good in some nowadays. So far hugo has my attention the most…

The end result is a little bit different. Docusaurus builds an SPA, page state is preserved when navigating and it makes it easy to interleave React components inside your doc.

Hugo is a more traditional SSG. Definitively faster to build than any Webpack/Babel alternative.

I have good hopes that SPA SSGs will become faster with esbuild, swc, sucrase.

Re: Docusaurus 2 Beta

#22

Post by slorber »

tony wrote: post #3

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…

Thanks for the feddback

No drawbacks to share compared to your previous stack?

Re: Docusaurus 2 Beta

#23

Post by slorber »

devsatish wrote: post #8

I use Docusaurus for internal documentation/websites , Code documentation. Makes beautiful documentation sites; Works great with node.js build pipelines. Check it out if you haven't yet.

Thanks for the feedback

Re: Docusaurus 2 Beta

#24

Post by slorber »

vlovich123 wrote: post #13

Overloaded with traffic or a bug in the WebServer? > Bad Request Description: Could not process this request.

It's a static site with cloudflare/netlify. It should work fine unless major CDNs have technical issued

Re: Docusaurus 2 Beta

#25

Post by nindalf »

ricopags wrote: post #6
ta1234567890 wrote: post #4

What 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/

How does it compare with say, mdbook?

Re: Docusaurus 2 Beta

#27

Post by alexktz »

CraigJPerry wrote: post #10

Just been going through a bunch of docs as code solutions trying to find something i like. I’m troubled by how slow and complicated some build process are. Docusaurus wasn’t the worst offender here although it has more moving parts than i’d like. If you’re still using Sphinx it might be worth a quick scan of the latest tools, the search facilities are quite good in some nowadays. So far hugo has my attention the most…

I tried dozens in the space and it sounds like you have too.

I settled on mkdocs for perfectmediaserver.com but hugo was up there too. mdbook is another great contender.

There are lots of almost what I want options. In the end mkdocs-material was close enough and I needed to ship.

Re: Docusaurus 2 Beta

#28

Post by Grimm1 »

This looks great, I looked on the API but I'm not sure if I'm missing this, is it possible to serve documentation to Docusaurus and have it generate from that served documentation? I've been working on, what I consider, a pretty powerful auto documentation tool and it'd be cool to integrate with this to produce self-hosted doc sites from our auto generated documentation.

I suppose we could generate separate markdown files as well and pass them to the CLI!

Either way I think I'll be adding support for Docusaurus in the near future, cool stuff!

Re: Docusaurus 2 Beta

#29

Post by swiley »

ricopags wrote: post #6
ta1234567890 wrote: post #4

What 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/

Oh man! An SPA for viewing pages!

Re: Docusaurus 2 Beta

#30

Post by qbasic_forever »

nindalf wrote: post #25
ricopags wrote: post #6

Earlier quoted context omitted.

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/

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 site and start clicking around to read docs it feels like a native app without clunky refreshes, etc. It's very extensible and can be turned into very custom and slick documentation portals.

It also supports MDX which is a a version of markdown that embeds React controls and allows interesting client-side interactivity in your documents. This is very handy for frontend libraries and tools which typically have a showcase or component library which you can interact directly from the docs.

Post reply on HN