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 660 public repositories matching this topic...

lprichar
lprichar commented Dec 14, 2021

Is there an existing issue for this?

  • I have searched the existing issues

Suggestion

There are many terms in ElectionGuard and adding links from every page to the Glossary for each term is a bit of a tall order. Luckily there is a [glossary feature provided by SquidFunk who make material design](https://squidfunk.github.io/mkdocs-material/reference/abbreviations/#adding-a

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

Latest release 3 months ago

Repository
mkdocs/mkdocs
Website
www.mkdocs.org