The Wayback Machine - https://web.archive.org/web/20220510080130/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 734 public repositories matching this topic...

ReenigneArcher
ReenigneArcher commented Apr 15, 2022

Details

build.jobs property is not allowed according to the published schema.

https://docs.readthedocs.io/en/stable/config-file/v2.html#build-jobs

Expected Result

A description of what you wanted to happen
jobs property and sub properties should be added to the schema
https://github.com/readthedocs/readthedocs.org/blob/464f20e77b63f550d10dcdaa0de9bab7a7f2e349/readthedocs/rt

Good First Issue Improvement Sprintable Accepted
keithrfung
keithrfung commented Feb 10, 2022

Is there an existing issue for this?

  • I have searched the existing issues

Suggestion

There are a couple problems with Sample Data that we would like to address.

  1. The sample data being out of date from the SDK
  2. Storing all the manifest sample data files within this repository

Possible Implementation

The large collection of sample data should be removed in favo

enhancement help wanted good first issue documentation
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

enhancement help wanted good first issue

Created by Tom Christie

Released 2014

Latest release about 1 month ago

Repository
mkdocs/mkdocs
Website
www.mkdocs.org