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
4
votes
1 answer

Wide table differences in Chrome vs Firefox in mkdocs-material

I am not really a html/css/js guy, but I am doing documentation for one project in MkDocs with Material theme. The problem here is that I have very wide tables and they are displayed differently in Chrome and Firefox, more concrete – they are…
Igor
  • 368
  • 3
  • 8
4
votes
2 answers

How Can I use Mkdocs on local computer without server?

I installed Mkdocs (Python 3.6.5) and edited and built Markdown files. I tried to open the main index.html file with a browser, but I cannot directly open HTML pages linked to other HTML files. Using Command Prompt and typing "mkdocs serve", I can…
masaovl
  • 41
  • 2
4
votes
1 answer

How to add custom inline styles in MkDocs material theme

I've been searching for a way to add custom styles to my markdown pages. I've been able to add "extra_css" to the yml file, but that seems to only affect the generated html. For example, I was able to add a custom style for images that causes ALL …
Seanmc2
  • 67
  • 1
  • 6
3
votes
1 answer

Error mkdocstrings generation error "No module named"

I was building a documentation site for my python project using mkdocstrings. For generating the code referece files I followed this instructions https://mkdocstrings.github.io/recipes/ I get these errors: INFO - Building…
egm2
  • 157
  • 1
  • 10
3
votes
1 answer

How to make nav recognize the title of a template

If nav is not set in mkdocs.yml, navigation is created automatically. The string is determined by the following priority the title of each page (h1 string starting with #) the file name I would like to display the h1 string in the navigation even…
isato
  • 141
  • 2
3
votes
0 answers

Gitlab Changelog API: Writing CHANGELOG that works with GitLab Pages

The GitLab Changelog API amends CHANGELOG.md with commit title and merge request information. However, it does it in a way to only work within GitLab UI (i.e., project-name@long-hash). My use case is to also publish the CHANGELOG.md using mkdocs…
astrochun
  • 1,642
  • 2
  • 7
  • 18
3
votes
1 answer

Different images for light/dark mode with Material for MkDocs

I am writing documentation using MkDocs and Material for MkDocs. I would like to have an image inside index.md that switch between two different versions when I switch from light to dark mode and vice versa. I've found different solutions online,…
chc
  • 498
  • 1
  • 4
  • 18
3
votes
2 answers

Cannot create docs for components in backstage docker error

I am trying to display docs stored in repository created by backstage io component on backstage-io /docs page UI, but when I am trying to access the docs I am getting the following error Building a newer version of this documentation failed. Error:…
Veera Silamban
  • 223
  • 1
  • 14
3
votes
2 answers

How to solve zsh: permission denied: mkdocs after pip installation?

I installed mkdocs using pip3. At the beginning, I couldn't run mkdocs => I got mkdocs command not found. Then, I located the installation path of pip and modified my ~/.zshrc path bash pip3 show mkdocs Name: mkdocs Version: 1.3.0 Summary:…
Enrico Bottazzi
  • 31
  • 3
3
votes
0 answers

Set page title as link text in markdown/mkdocs

Is there a way for the link text to be generated from the title of the link target within the same site? Suppose I have a page named target.md with # Some Title Here. Can I generate a link, say using the syntax [#something](target.md) (or any other…
ajthealchemist
  • 127
  • 8
3
votes
1 answer

mkdocs include with --8<-- not interpreted

I'm using mkdocs to create html web pages and snippets extension to fragment my master documents into small pieces. I have an incomprehensible bug: In the file file1.md I…
Sebastien Hoarau
  • 76
  • 4
3
votes
2 answers

Jinja2 : Variable call impossible within markdown from two disticnt template using jinja2

I am using jinj2 inside markdown files to create a documentation template via Mkdocs. The whole process is created through a pipeline so I get to see what is done by the jinja2 code I write inside my templates, but there is that one particular…
Jinja_dude
  • 404
  • 5
  • 20
3
votes
1 answer

I was trying to implement datatables in my Mkdocs material theme. But adding the custome code for datatables doesnt work

Trying to get datatable into my mkdocs material theme. I tried different ways but it does not work consistently, sometimes work after page-referesh. mkdocs.yml extra_css: - extra.css -…
Byju Aravind
  • 31
  • 1
3
votes
2 answers

How do I keep Azure DevOps from treating infos and warnings as errors in my pipeline?

I am working on an Azure DevOps pipeline created without YAML. In the pipeline, node.js and npm are used to build some web interfaces. mkdocs is used to build web documentation. My problem is that Azure DevOps treats some infos and warnings as…
Christian
  • 317
  • 1
  • 14
3
votes
0 answers

How to deploy mkdocs site on GitHub Pages under *custom directory*

The general idea is to have multiple mkdocs documentation sites under a single repository. Like this: - index.html # landing page - /product1/getting-started/ - /product2/getting-started/ I use this script .github/workflows/ci.yml to deploy…
karlisup
  • 672
  • 12
  • 22
1 2
3
…
19 20