Our great sponsors
-
-
ToolJet
Low-code platform for building business applications. Connect to databases, cloud storages, GraphQL, API endpoints, Airtable, Google sheets, OpenAI, etc and build apps using drag and drop application builder. Built using JavaScript/TypeScript. 🚀
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
-
-
-
-
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
react-test
🧯 Make readable assertions for your App and be confident about the code you ship. Reduce user-facing bugs and increase satisfaction.
-
crossroad
🛣 A React library to handle navigation in your WebApp. Built with simple components and React Hooks so your code is cleaner. (by franciscop)
-
-
-
-
nextra
Simple, powerful and flexible site generation framework with everything you love from Next.js.
-
typesense-docsearch-scraper
A fork of Algolia's awesome DocSearch Scraper, customized to index data in Typesense (an open source alternative to Algolia)
-
-
-
-
-
-
doks
Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.
-
just-the-docs
A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
-
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
We are using Docusaurus (https://docusaurus.io/ ). It is easy to configure/customise and looks really great out of the box. In our case, we just had to change the colors and font.
Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.io/
We are using Docusaurus (https://docusaurus.io/ ). It is easy to configure/customise and looks really great out of the box. In our case, we just had to change the colors and font.
Here is our Docusaurus code if that's helpful: https://github.com/ToolJet/ToolJet/tree/develop/docs and here is the live documentation: https://docs.tooljet.io/
Background: I've been a technical writer for 9 years. 6 at Google, 3 as the only writer at an IoT startup.
I helped Corrily with their docs [1] in August. They were interested in readme.io. I wasn't keen on it because I had worked with Retool a few years back and had found readme.io lacking. But I was pleasantly surprised by how much readme.io has progressed since then! If you're looking for a documentation product that is very easy to update and mostly just works, then it's worth checking out.
On https://web.dev I was introduced to Eleventy. Eleventy [2] is now my go to. The documentation for Elecenty itself is very strangely organized and needs a refactor. But I have found that there is always a way to accomplish whatever I need, and usually elegantly.
Another project worth checking out is Docsy [3]. This is a Jekyll template specifically created for technical documentation.
Back at the IoT startup I had to set up the whole documentation system / tooling myself. I used Sphinx and deployed to Heroku. Haven't used Sphinx since then but I remember being satisfied with it back then.
[1] https://docs.corrily.com
[2] https://11ty.dev
[3] https://docsy.dev
On a new side project I'm working on I need to have a fair amount of documentation for usage, implementation, options, etc. In the past I've used https://docsify.js.org hosted on Vercel, but I was curious if there is anything else out there people like. Looking for free or paid options. So long has I can host on a subdomain I'm indifferent.
Thanks!
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/
I have an unfinished side project called Documentation Page:
https://documentation.page/
It's "unfinished" because I'd need to integrate payments and do all the accounting on my side (non-trivial as an individual living in Japan), but otherwise it's worked pretty well for my own projects.
It parses your Github Repo (according to https://documentation.page/documentation#getting-started) to generate the website. It can be a single readme.md file (for smaller projects), a folder called "documentation", or you can configure it otherwise. Some examples hosted by Documentation Page:
- statux.dev: simple single-page docs and website, menu config in https://github.com/franciscop/statux/blob/master/documentati.... Similar to form-mate.dev & vector-graph.com
- react-test.dev: split into multiple pages, you specify the folder and it'll automatically merge the markdown files. See config https://github.com/franciscop/react-test/blob/master/documen...
- crossroad.page: has an landing page, but that is not officially supported (yet). See the configs in https://github.com/franciscop/crossroad/blob/master/document...
I have an unfinished side project called Documentation Page:
https://documentation.page/
It's "unfinished" because I'd need to integrate payments and do all the accounting on my side (non-trivial as an individual living in Japan), but otherwise it's worked pretty well for my own projects.
It parses your Github Repo (according to https://documentation.page/documentation#getting-started) to generate the website. It can be a single readme.md file (for smaller projects), a folder called "documentation", or you can configure it otherwise. Some examples hosted by Documentation Page:
- statux.dev: simple single-page docs and website, menu config in https://github.com/franciscop/statux/blob/master/documentati.... Similar to form-mate.dev & vector-graph.com
- react-test.dev: split into multiple pages, you specify the folder and it'll automatically merge the markdown files. See config https://github.com/franciscop/react-test/blob/master/documen...
- crossroad.page: has an landing page, but that is not officially supported (yet). See the configs in https://github.com/franciscop/crossroad/blob/master/document...
I have an unfinished side project called Documentation Page:
https://documentation.page/
It's "unfinished" because I'd need to integrate payments and do all the accounting on my side (non-trivial as an individual living in Japan), but otherwise it's worked pretty well for my own projects.
It parses your Github Repo (according to https://documentation.page/documentation#getting-started) to generate the website. It can be a single readme.md file (for smaller projects), a folder called "documentation", or you can configure it otherwise. Some examples hosted by Documentation Page:
- statux.dev: simple single-page docs and website, menu config in https://github.com/franciscop/statux/blob/master/documentati.... Similar to form-mate.dev & vector-graph.com
- react-test.dev: split into multiple pages, you specify the folder and it'll automatically merge the markdown files. See config https://github.com/franciscop/react-test/blob/master/documen...
- crossroad.page: has an landing page, but that is not officially supported (yet). See the configs in https://github.com/franciscop/crossroad/blob/master/document...
We (Handsontable) now use VuePress[1] for our docs[2] and we are very happy with it. The best feature for us is the ease of customization.
Our challenge right now is to get a better code snippet runner, but that's beyond the scope of your regular documentation management tool, I suppose.
[1] https://vuepress.vuejs.org/
[2] https://github.com/juicedata/juicefs/blob/main/docs/en/how_t...
I've not used it yet - but planning to give Nextra (https://nextra.vercel.app/) a go next time around.
The 'docs' theme is intended as a quick way to produce a documentation website based on Next, which you can obviously customise further with your own components if needed.
We tried to use Typesense for the search bar. We could not wrap up the PR due to bandwidth issues but it should be a great alternative for Algolia. Link: https://github.com/typesense/typesense-docsearch-scraper
mdBook (or Gitbook) is also an option. A bit more general than just for docs, though they advertise it as a first class use case.
https://github.com/rust-lang/mdBook
We use [TypeDoc](https://typedoc.org/) to generate documentation from all of our TypeScript. It combines type definitions with surrounding comment blocks for easily navigable, clean documentation.
For non-TypeScript codebases, we use [Docusaurus](https://docusaurus.io/).
I believe there are also plugins which can make TypeDoc output compatible with Docusaurus.
A small Perl script <https://github.com/jmarshall/manconvert> that grinds a subset of man page nroff syntax directly into HTML. (That subset being “the constructs that are used in the man pages that it's used on”.)
Some of the styling could be improved (those section headings for one!), but IMHO it produces better results than other more general-purpose manpage to HTML converters: see e.g. <https://www.htslib.org/doc/samtools.html>.
A markdown generator embeds markdown from a Github repo into the marketing site. This way the marketing site is kept private while anyone can easily contribute to docs.
Docs are kept in separate folders for each release.
https://github.com/multiprocessio/datastation-documentation
Background: I've been a technical writer for 9 years. 6 at Google, 3 as the only writer at an IoT startup.
I helped Corrily with their docs [1] in August. They were interested in readme.io. I wasn't keen on it because I had worked with Retool a few years back and had found readme.io lacking. But I was pleasantly surprised by how much readme.io has progressed since then! If you're looking for a documentation product that is very easy to update and mostly just works, then it's worth checking out.
On https://web.dev I was introduced to Eleventy. Eleventy [2] is now my go to. The documentation for Elecenty itself is very strangely organized and needs a refactor. But I have found that there is always a way to accomplish whatever I need, and usually elegantly.
Another project worth checking out is Docsy [3]. This is a Jekyll template specifically created for technical documentation.
Back at the IoT startup I had to set up the whole documentation system / tooling myself. I used Sphinx and deployed to Heroku. Haven't used Sphinx since then but I remember being satisfied with it back then.
[1] https://docs.corrily.com
[2] https://11ty.dev
[3] https://docsy.dev
We have an handmade website using Next.js. It generate the documentation from the markdown files present in the `content` folder. It was not the easiest path, but it does the job.
Code: https://github.com/mockoon/mockoon.com
