The Wayback Machine - https://web.archive.org/web/20210627071259/https://github.com/topics/mkdocs
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 577 public repositories matching this topic...

humitos
humitos commented Mar 4, 2021

While working with external services, like GitHub or Stripe, it's handy to use ngrok (https://ngrok.com) to access the instance running locally on Docker for a domain publicly accessible. However, there are some changes required to make it work.

diff --git a/docker-compose.override.yml b/docker-compose.override.yml
index e88276dbd..a1d28c6c0 100644
--- a/docker-compose.override.yml
NiklasRosenstein
NiklasRosenstein commented Jun 14, 2020

You can have two API objects that use the same anchor reference. When both are rendered into the same Markdown file, the references are not unique, and one of the links will not work.

def a():
  """ Links to [a][0].

  [0]: https://a.org """

def b():
  """ Links to [b][0].

  [0]: https://b.org """

The MarkdownRenderer should find such duplicate references (here 0 an

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

Created by Tom Christie

Released 2014

Repository
mkdocs/mkdocs
Website
www.mkdocs.org