MkDocs for a Knowledgebase
#1
We are using Mkdocs, a static site generator, for a knowledgebase that'll be for our clients in the near future. According to the MkDocs description, they are:

Quote:MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

I use PhpStorm which makes working with MkDocs a breeze. The Material theme, by Martin Donath (aka squidfunk on Github), is awesome. It has so many necessary features that it's almost a must have, IMO. 

When deciding on what platform to use for our KB, we looked at several options. We settled on MkDocs as we wanted a lightweight platform without a database as we don't really need a db for a static site. Yes, it takes a bit of time to learn how to use MkDocs, but that's true with anything. Once you learn how to make pages, menus, etc, you're golden. 

MkDocs has SEO tools, and the Material theme has extra tools to extend those features. You can also mark articles as new, advanced, etc with statuses if using the Material theme:

.png   pagestatus.png (Size: 69.18 KB / Downloads: 7)

In the above image, you can see the statuses to the right of the menus (Deprecated, Happy, Section). That's very handy when making tutorials as you can mark new ones, archived or deprecated posts, advanced, etc etc.

The site search is zippy fast. In fact, the whole KB we have is fast. It's also scoring very high on accessibility, with many pages already at 100%.  Cool

Don't let the initial "coding" aspect of creating the pages scare you. It's not that hard. Really. Should you want to set one up, and get stuck, start a thread and ping me in it (or PM the thread link to me) and I'll try my best to guide you along.  Smile
Reply


Forum Jump: