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

11–20 of 61 posts

Re: Docusaurus 2 Beta

#11

Post by swyx »

ricopags wrote: post #5
slorber wrote: post #2

Oh sweet, it's the first time I work on something and someone else post the link to Hacker News :D

Love docusaurus and since this is a chance to surface something to the devs that isn't worth creating an issue for: Would an "internal" mode as an option make any kind of sense? I know most people who are using docusaurus are doing so for public facing docs and they don't mind exposing github edit links. Wondering if a flag could be set that would cater the options for corp/internal documentation somehow. I'm not a d…

this already exists - set the editUrl in your docusaurus config. https://github.com/temporalio/documentation/blob/master/docu...

if you dont want your docs public facing you can put a password wall on it, but thats a feature of your hosting provider (eg netlify), not so much docusaurus.

Re: Docusaurus 2 Beta

#14

Post by dassmario »

I remember there was a ShowHN post a couple of months ago of a product with a really beautiful web page that used Docusaurus. If I recall correctly, they offered some kind of service related to AWS. Their docs were on GitHub and used a custom dark theme with pink buttons. I can't remember their name. Didn't find them in the docusaurus.io examples. Anyone else remembers this product and its name?

Re: Docusaurus 2 Beta

#15

Post by slorber »

swyx wrote: post #11
ricopags wrote: post #5

Earlier quoted context omitted.

Love docusaurus and since this is a chance to surface something to the devs that isn't worth creating an issue for: Would an "internal" mode as an option make any kind of sense? I know most people who are using docusaurus are doing so for public facing docs and they don't mind exposing github edit links. Wondering if a flag could be set that would cater the options for corp/internal documentation somehow. I'm not a d…

this already exists - set the editUrl in your docusaurus config. https://github.com/temporalio/documentation/blob/master/docu... if you dont want your docs public facing you can put a password wall on it, but thats a feature of your hosting provider (eg netlify), not so much docusaurus.

Yes! We also accept an editUrl callback for maximum customizability

Re: Docusaurus 2 Beta

#16

Post by slorber »

swyx wrote: post #9
slorber wrote: post #2

Oh sweet, it's the first time I work on something and someone else post the link to Hacker News :D

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

Re: Docusaurus 2 Beta

#17

Post by slorber »

dassmario wrote: post #14

I remember there was a ShowHN post a couple of months ago of a product with a really beautiful web page that used Docusaurus. If I recall correctly, they offered some kind of service related to AWS. Their docs were on GitHub and used a custom dark theme with pink buttons. I can't remember their name. Didn't find them in the docusaurus.io examples. Anyone else remembers this product and its name?

I don't know but I'm curious maybe QuestDB?

Re: Docusaurus 2 Beta

#18

Post by abought »

slorber wrote: post #2

Oh 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-edited API docs (example: Babel - https://raw.githubusercontent.com/babel/website/main/docs/pa...). I'd love to see a system that supported building and showing API docs and prose guides in one site, or at least allowed automated cross-linking in a way that could be kept up to date.

Re: Docusaurus 2 Beta

#19

Post by bfrog »

I 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.

Re: Docusaurus 2 Beta

#20

Post by swyx »

slorber wrote: post #15
swyx wrote: post #11

Earlier quoted context omitted.

this already exists - set the editUrl in your docusaurus config. https://github.com/temporalio/documentation/blob/master/docu... if you dont want your docs public facing you can put a password wall on it, but thats a feature of your hosting provider (eg netlify), not so much docusaurus.

Yes! We also accept an editUrl callback for maximum customizability

btw i couldnt find docs on editUrl... the algolia searchbox on docusaurus needs some fixing
Post reply on HN