Skip to content
#

MkDocs

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.

Here are 399 public repositories matching this topic...

humitos
humitos commented Apr 21, 2020

Our current sitemap.xml covers the most basic case. Although, there are users with other needs that require a more customized sitemap.xml.

We should implement the same mechanism that we do for custom 404.html, where we provide the most basic one (Maze found) with the ability to change it by adding your own 404.html to the output generated by Sphinx.

So, we could check first for `sitema

estan
estan commented Jan 25, 2019

It would be great if there was a function in the theme handler in which I could modify the HTML before it's converted to PDF, for example to add a title page.

(At the moment, I tried to add a title page by combining the output with a pre-made PDF for the title page using Ghostscript, but the problem is that Ghostscript ruins all the named destinations links, so internal links won't work. Would

robfalck
robfalck commented May 29, 2020

I'm attempting to use mkdocs in conjunction with my module's test suite to ensure that all of my documented examples function correctly.

My certain unittest.TestCase methods generate plot files that I would like to embed in my documentation.

My intended procedure for building documentation is:

  1. run my unit tests
  2. assuming they all pass, build my documentation

My macros are below. T

Created by Tom Christie

Released 2014

Repository
mkdocs/mkdocs
Website
www.mkdocs.org
You can’t perform that action at this time.