Ask HN: What are you using for public documentation these days?

Re:Ask HN: What are you using for public documentation these... by tomw1808 on Thursday November 18, 2021 @07:24AM (#29264621)

I'm using mkdocs with the material plugins [1]. I'm running it mainly for a Blockchain Education site for my labs from my course, which seems to be fine [2].

I did a fair amount of customization though, so I am running all this as mkdocs plugins, not directly from the materials project.

[1] https://squidfunk.github.io/mkdocs-material/ [2] https://ethereum-blockchain-developer.com

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by tedyoung on Thursday November 18, 2021 @03:41PM (#29270233)

Another +1 from me for mkdocs and mkdocs-material (and I'm also a supporter of squidfunk). I use it for lab exercises[1] as part of my online courses (deployed onto Netlify). It just works and looks good.

[1] https://moretestable.com

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by 4kelly on Thursday November 18, 2021 @08:23AM (#29265072)

+1 for Material MkDocs. It’s beautiful and functional by default so I can just focus on documenting.

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by twalla on Thursday November 18, 2021 @12:29PM (#29268033)

Another happy user of mkdocs, also really like gitbook. If I had to choose something for people who didn't like git/plaintext and wanted richer embeds, I think I'd suggest Notion.

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by evolve2k on Thursday November 18, 2021 @07:54AM (#29264854)

Oh wow this looks great! Simple conversion of markdown into an opinionated simple to use really nice looking doc site.!

Cheers for this :)

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by sixhobbits on Thursday November 18, 2021 @09:53AM (#29266072)

+1000 for the "Material for MkDocs" project by squidfunk - we (Ritza.co) do documentation for various companies and we've strongly encouraged them to all switch to this since we found it. Fast, beautiful, simple.

The free version is really nice but also very happy to pay for the 'insiders' version via GitHub donations.

[ Parent | on HN ]

Re:Ask HN: What are you using for public documentation these... by squidfunk on Thursday November 18, 2021 @10:58AM (#29266894)

Thanks for your continued support!

[ Parent | on HN ]