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

mkdocs-material
rroblik
rroblik commented Nov 29, 2019

Hi,

Description

I asked myself how to easily add a "post article" custom content (right just before closing </article> (or after ?) BUT inside the <main> tag ?

Goal

My goal is to add static content on very page above the main content, at template level using native override capabilities.

Detai

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
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

majkinetor
majkinetor commented Jan 6, 2020

Currently:

The root directory for your included files is in docs_dir

How about making this plugin configuration that defaults to docs_dir if not set ?

- macros:
      root_dir:  inc       <== relative to the mkdocs.yml location

Currently I need to put this in the docs folder with other files, but then those files get rendered also which is wrong as they are partial

digitaldonkey
digitaldonkey commented Oct 12, 2019

Documentation says "site_name must adhere follow the regular expression: ^[a-zA-Z0-9_-/]+$"

My problem with that is that if you also want to single-build the repos you end up with a ugly site_name in the frontend. I wonder if you can introduce a new property like submodule_alias to work around that issue.

You may also autogenerate the machine name (lowercase, replace spaces and strip out s

Created by Tom Christie

Released 2014

Repository
mkdocs/mkdocs
Website
www.mkdocs.org

Related Topics

material python
You can’t perform that action at this time.