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

htleeab
htleeab commented Apr 30, 2020

I'm considering switch to mkdocs from sphinx, but cannot solve the navigation issue.
This is a sample built with sphinx + recommonmark+ readthedocs theme+ readthedocs host
readthedocs theme should support

  1. multi-level nav
  2. clickable index links/page
  3. auto-generate TOC with sub-leve
claverru
claverru commented Oct 23, 2019

Hello @NiklasRosenstein,

I like this library a lot, I find it so useful. Though, I would like to be able to include images in both README.md and index.md. Let me explain:

PROBLEM

  • Let say README.md is at the project's root, as usually.
  • I have a folder named sources, which is also specified at the pydocmd.yml as docs_dir: sources.
  • Finally, I specify
    `pages: - Home: index.m
pawamoy
pawamoy commented Apr 13, 2020

From #82.

Instead of a warning we could simply add a debug log with the path to the used template using its filename attribute, though with the current code each handler must do it.

Also we have no control within the Jinja rendering: when we {% include "template.html" %} we can't even issue a debug log to tell which one was picked up, so I'm not sure about the usefulness of just logging

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

vicaya
vicaya commented Dec 17, 2019

.pages.arrange is a convenient layout overriding mechanism. It'd be great if you can make it work a little more like the nav directive. e.g.

arrange:
  - Home: README.md
  - Background: background-materials-directory

The first form (<title>: <file.md>) is identical to nav. The second form would save us from having to create a .pages file with a title directive just to override th

ryandaugherty
ryandaugherty commented Mar 2, 2020

Oooh wouldn't this be so cool... :)

So you mention the ability to use git submodules to include the mkdocs.yml + docs in other repositories. If these sub-repos (let's call them) are standalone mkdocs directories without any developer code, this works.

However, let's say you have a bunch of dev code in a sub-repo, but you also want to have the documentation live there in a 'docs' folder. An

Created by Tom Christie

Released 2014

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