Hacker News new | past | comments | ask | show | jobs | submit login
Ask HN: Best platform for hosting documentation for your product (paid, or not)
5 points by abhaysaxena_hk on Jan 19, 2021 | hide | past | favorite | 11 comments
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?





https://www.gitbook.com/

or 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)

Both use markdown.


Docusarus looks good.


We sell a hosted one[0] called Miki with all those features.

http://miki.mimix.io


That looks good! Bookmarked for later.

Demo/Example link: https://nebula.mimix.io/


Thank you! The product was built 100% from dogfooding! :-)


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.



Would Read the Docs suit your needs?

https://docs.readthedocs.io/en/stable/


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


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




Join us for AI Startup School this June 16-17 in San Francisco!

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: