Static Documentation Generators

1

Hey friends! The documentation thread got me thinking about something that I wanted to ask in a new thread. I’ve been looking for the right solution and I was wondering if you guys have heard of or used anything like this in the past.

What I’m looking for is a static site generator built around the purpose of generating product documentation, preferably closer to “well that was easy to install” and a bit further from “why am I making 16 docker containers and linking them together for this?” Ideally it would accept markdown files and make them pretty :slight_smile:

These are a couple I’m looking at, but before I get in too deep I was hoping you guys might have some insight on the topic:

http://www.mkdocs.org/
https://docusaurus.io/en/
1 Like
2

There’s also Sphinx (I’ve not used it personally), it’s widely used and the documentation it produces is nice looking (example here).

However it’s not taking markdown but reStructuredText instead.

1 Like
3

I really like the way that looks though, just clean and simple, ty!

4

I use mkdocs works well for my needs.

2 Likes
5

I just want to bump this and see if there’s any other suggestions. I have been browsing while lacking my password these past few days and I’m also interested in simplistic static document generation. I think I’m going to try the one suggested a couple posts above.

6

if you want a general purpose static site generator try hugo

but if you are looking for static documentation generation use mkdocs because it supports markdown and many other features

2 Likes
7

I’ve bookmarked both as they both look pretty neat!

8

okay did I mention they work great with hyphens lol :wink:

1 Like
9

Planning to migrate to Mkdocs soon. Looking forward to not writing docs in html.

Pavin.

1 Like
10

So I set up MKDocs on a machine, the setup was simple and the guide to editing and creating files seems easy enough. Gonna put something together when I have a terminal.

1 Like
11

Can recommend it, just finished mine.

Pavin.

1 Like
12

Looks great!

1 Like
13

Another vote for MkDocs, really nice, builds on GitHub Pages easily though Travis and is even me-proof. https://docs.pi-hole.net/

2 Likes