Open Water Foundation / Learn MkDocs

This documentation provides resources to learn how to to use the MkDocs software, which creates static documentation websites from Markdown source files. A static website can be viewed on a local computer and can be published to the web. Such documentation can be developed for software products as developer and user documentation. Documentation can also be created for other projects where navigable documentation is desirable.

This documentation has been written based on experience using MkDocs at the Open Water Foundation.

The documentatio that you are reading has itself been created with MkDocs.

About the Open Water Foundation

The Open Water Foundation is a 501(c)3 nonprofit social enterprise that focuses on developing and supporting open source software for water resources, so that organizations can make better decisions about water. OWF also works to advance open data tools and implementation. OWF has created this documentation to educate its staff, other developers, and clients that use MkDocs for documentation.

See also other OWF learning resources.

How to Use this Documentation

The documentation is organized in order of information and tasks necessary to setup a development environment and use MkDocs software.

This documentation is not intended to be a full reference for MkDocs or Markdown but focuses on topics that will help understand important technical concepts and be successful with MkDocs.

License

The OWF Learn MkDocs website content and examples are licenses under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Source Repository on GitHub

The source files for this documentation are maintained in a GitHub repository: owf-learn-mkdocs.

MkDocs

This documentation is prepared using MkDocs. For full MkDocs documentation visit mkdocs.org.

Release Notes

The following release nodes indicate the update history for documentation: