We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

MkDocs: Documenting projects with Markdown

Formal Metadata

Title
MkDocs: Documenting projects with Markdown
Title of Series
Part Number
34
Number of Parts
173
Author
License
CC Attribution - NonCommercial - ShareAlike 3.0 Unported:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal and non-commercial purpose as long as the work is attributed to the author in the manner specified by the author or licensor and the work or content is shared also in adapted form only under the conditions of this
Identifiers
Publisher
Release Date
Language
Production PlaceBilbao, Euskadi, Spain

Content Metadata

Subject Area
Genre
Abstract
Dougal Matthews - MkDocs: Documenting projects with Markdown MkDocs is a Python library for creating documentation with Markdown. The primary goal of the project is to lower the barrier for documentation writers and to help enable high quality prose based documentation. The primary maintainer of MkDocs will cover the following topics: - An introduction to MkDocs and the project goals. - How and why did the project start? - Who uses MkDocs today? - Discuss what we need to do to create great documentation and how MkDocs can help. - A tour of the key features currently in MkDocs - Adding MkDocs to your project. - Using themes in the documentation and making customisations - Publishing your documentation with ReadTheDocs and GitHub pages. - A look at the up and coming features in MkDocs and how you can help make these happen. - A comparison with Sphinx and why you should consider MkDocs.
Keywords