4 ms·

Ask HN: Best platform for hosting documentation for your product (paid, or not)

What are you guys using for your products' technical documentation? I am looking for a service, or even a GitHub repo which we can host ourselves where our documentation team can put up technical documentation. In addition to product docs, we also want to create a learning center about real-estate (which is the industry we are in) Ideal requirements are - Ability to write content in markdown - Display articles by category - show TOC inside an article - Follow good SEO practices I have looked at Zendesk, which is expensive. Also looked at Crisp (which is a messenger and but also has Helpdesk). The problem with Crisp is that the articles are kind of locked in their platform. (I am not associated with either of those companies) What do you guys use?

Firecracker 6y ago
Would Read the Docs suit your needs? https://docs.readthedocs.io/en/stable/ https://docs.readthedocs.io/en/stable/
mardiyah 6y ago
Siteground https://documentor.in/recommends/siteground/ https://documentor.in/recommends/siteground/ Bluehost https://documentor.in/recommends/bluehost/ https://documentor.in/recommends/bluehost/ Hostgator https://documentor.in/recommends/hostgator/ https://documentor.in/recommends/hostgator/
throwaway888abc 6y ago
Also to consider https://jamdocs.samuelhorn.com/ https://jamdocs.samuelhorn.com/ https://docsify.js.org/#/ https://docsify.js.org/#/
stazz1 6y ago
GitHub Wikis are legit and very useful! Not sure if you mean specific function documentation... Check out clojuredocs. I'm not sure what the backend is but the ability to quickly search and see related functions is really nice.
mtmail 6y ago
https://www.gitbook.com/ https://www.gitbook.com/ or https://docusaurus.io/ https://docusaurus.io/ by Facebook which gives more control and it seems you use Javascript/React already for your frontend (https://news.ycombinator.com/item?id=25784642 https://news.ycombinator.com/item?id=25784642) Both use markdown.
- kamroot 6y ago
  Docusarus looks good.
phendrenad2 6y ago
How technical are your docs? Are your customers using a SaaS or are they programming against your APIs?
- abhaysaxena_hk 6y ago
  The docs are not technical. They are mostly about how to use the SaaS product and additional about how real-estate finance works.
mimixco 6y ago
We sell a hosted one[0] called Miki with all those features. http://miki.mimix.io http://miki.mimix.io
- throwaway888abc 6y ago
  That looks good! Bookmarked for later. Demo/Example link: https://nebula.mimix.io/ https://nebula.mimix.io/
  - mimixco 6y ago
    Thank you! The product was built 100% from dogfooding! :-)

Firecracker 6y ago

Would Read the Docs suit your needs? https://docs.readthedocs.io/en/stable/ https://docs.readthedocs.io/en/stable/

mardiyah 6y ago

Siteground https://documentor.in/recommends/siteground/ https://documentor.in/recommends/siteground/ Bluehost https://documentor.in/recommends/bluehost/ https://documentor.in/recommends/bluehost/ Hostgator https://documentor.in/recommends/hostgator/ https://documentor.in/recommends/hostgator/

throwaway888abc 6y ago

Also to consider https://jamdocs.samuelhorn.com/ https://jamdocs.samuelhorn.com/ https://docsify.js.org/#/ https://docsify.js.org/#/

stazz1 6y ago

GitHub Wikis are legit and very useful! Not sure if you mean specific function documentation... Check out clojuredocs. I'm not sure what the backend is but the ability to quickly search and see related functions is really nice.

mtmail 6y ago

https://www.gitbook.com/ https://www.gitbook.com/ or https://docusaurus.io/ https://docusaurus.io/ by Facebook which gives more control and it seems you use Javascript/React already for your frontend (https://news.ycombinator.com/item?id=25784642 https://news.ycombinator.com/item?id=25784642) Both use markdown.

kamroot 6y ago
Docusarus looks good.

phendrenad2 6y ago

How technical are your docs? Are your customers using a SaaS or are they programming against your APIs?

abhaysaxena_hk 6y ago
The docs are not technical. They are mostly about how to use the SaaS product and additional about how real-estate finance works.

mimixco 6y ago

We sell a hosted one[0] called Miki with all those features. http://miki.mimix.io http://miki.mimix.io

throwaway888abc 6y ago
That looks good! Bookmarked for later. Demo/Example link: https://nebula.mimix.io/ https://nebula.mimix.io/
- mimixco 6y ago
  Thank you! The product was built 100% from dogfooding! :-)