Stack Overflow
Stack Overflow

Questions tagged [mkdocs]

Static site generator geared towards building project documentation

MkDocs Overview :

MkDocs is a fast, simple 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.

MkDocs is currently still in development and v1.0 is yet to be released.

Installation & More about MkDoc

286 questions
6
votes
5 answers

How to Create Tabbed Code Blocks in Mkdocs or Sphinx?

Is there a way to create tabbed code blocks like the following in Mkdocs or Sphinx?
Grokify
  • 15,092
  • 6
  • 60
  • 81
5
votes
1 answer

Mkdocs unable to find modules

I'm trying to generate automated documentation, using : mkdocs = "^1.4.2" mkdocstrings = "0.19.0" mkdocs-material = "8.5.8" mkdocstrings-python = "0.7.1" my mkdocs.yml looks like this : site_name: Optimization Services Documentation site_url:…
Grégoire Archambeaud
  • 51
  • 1
5
votes
1 answer

Referencing table values from md file in dbt yaml files

I have a markdown file with a table in it and I have another dbt schema.yml file which is used to serve and generate docs. Traditionally I enter the table name and column name and description of the column name in schema.yml but now that I think of…
NAB0815
  • 441
  • 4
  • 24
5
votes
2 answers

Making sub menus to appear as drop down menus at top in mkdocs material theme

Is it possible to have drop down menu something like this in mkdocs-material theme: By default, it seems material theme renders only top level menu below title with sub menus in left side bar. I am ok if left side bar is preserved. I just want to…
Rnj
  • 1,067
  • 1
  • 8
  • 23
5
votes
1 answer

Add script tag to markdown file

I am developing document in MKdocs and need to load some script files to my markdown file. How can I add js functions and script tags in markdown?
Rajitha Kothapally
  • 253
  • 1
  • 3
  • 11
5
votes
1 answer

Getting "NotImplementedError" from Mkdocs serve command

I am setting up a documentation using mkdocs but I am getting "NotImplementedError" when runing the "mkdocs serve" command Note that I am working on windows 10 and installed the Python 3.8.0a3 version INFO - Building documentation... INFO - …
Anthony
  • 185
  • 1
  • 14
4
votes
1 answer

Automatically generate API reference for all subpackages / modules

I am using mkdocs with the mkdocstrings plugin to generate the documentation of my Python package. My package is organized in a standard fashion - setup.py - mkdocs.yaml - docs/ - mypackage/ - __init__.py - module1.py - module2.py -…
Vince
  • 3,979
  • 10
  • 41
  • 69
4
votes
2 answers

MkDocs with mkdocstrings fails to serve with "Could not collect" error

I am using the Python MkDocs tool to build API documentation extracted directly from the source using the MkDocs mkdocstrings extension. When I run the mkdocs serve command inside my project (in the directory which contains the mkdocs.yml file), the…
Stephen Gaito
  • 93
  • 1
  • 5
4
votes
1 answer

How to check dead links in a Gitlab CI job which builds a static site with MkDocs?

I use the TBC MkDocs Gitlab-CI template to build, then publish a static site which contains a lot of links to other sites. So I should want to add in my CI job a check to verify: If all my internal links (within the web site) are ok if all my…
Jean-Louis FEREY
  • 41
  • 1
4
votes
1 answer

mkdocs - dynamic list of child pages

Is there a way to dynamically generate a list of files under the current page's folder structure in mkdocs? I'm looking for something kind of like the Confluence "children display" macro, so that if my folder structure…
wrschneider
  • 17,913
  • 16
  • 96
  • 176
4
votes
1 answer

mkdocs - How can I specify toc_depth for a single document?

I want to change the depth of the number of headers the table of contents present on the TOC. I can see toc_depth option exists as a configuration option but this is global. Is there a way to specify a single document? Cheers
Ariel
  • 529
  • 2
  • 13
4
votes
2 answers

I have a problem with running the mkdocs serve command

I tried running the mkdocs serve command on the windows command prompt but it wasn't working. I get the following error:INFO - Building documentation... ERROR - Config value: 'markdown_extensions'. Error: Failed loading extension…
Aiden Chow
  • 391
  • 6
  • 17
4
votes
2 answers

mkdocs nav title different from page title

My mkdocs.yml file has nav titles that are shortened to fit onto only 1 line each in the left-side navigation, and I want the .md Markdown page title to be the un-abbreviated full-length title. For example, while my mkdocs.yml file contains: nav: -…
Guy Klages
  • 41
  • 1
  • 4
4
votes
4 answers

ERROR - Config value: 'theme'. Error: Unrecognised theme name:

The solution to similar issues on Github about this all point to installing MkDocs or the theme with a package manager and not pip. However, I have installed both with pip. Installed MkDocs with pip (not a package manager) Installed n number of…
mark
  • 41
  • 1
  • 4
4
votes
2 answers

How to add permalinks to tree nodes in Markdown nav file (mkdocs.yml)?

The mkdocs.yml nav file I am working with includes a hierarchical tree of a manuals website with several categories and subcategories the content articles fall into; the tree is absolutely virtual and not based on a folder structure/website path. I…
CyberHead
  • 41
  • 2
1
2
3
…
19 20