mahmoud / awesome-python-applications

💿 Free software that works great, and also happens to be open-source Python.
ftp://you:relookin@it#readme
16.78k stars 2.68k forks source link

Add Project: MkDocs #95

Closed wbhinton closed 5 years ago

wbhinton commented 5 years ago

Basic info

Application name: MkDocs Application repo link: https://github.com/mkdocs/mkdocs Application home link: http://www.mkdocs.org/ Application description: 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.

Qualifications

There are a ton of great Python projects out there, but what makes an application "Awesome™"? Please check that all of the following criteria apply:

Note that installability via pip/PyPI and a developer-audience focus may warrant a higher standard for inclusion, in keeping with the spirit of the list: http://sedimental.org/awesome_python_applications.html

Additional notability info

Overview

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.

Host anywhere

MkDocs builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.

Great themes available

There's a stack of good looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the 3rd party themes in the MkDocs wiki, or build your own.

Preview your site as you work

The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.

mahmoud commented 5 years ago

I completely agree mkdocs belongs on the list! so much so that in fact it's already made its debut: https://github.com/mahmoud/awesome-python-applications#tag-dev.docs :) Thanks and continue keeping an eye out!