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

Auto deploy mkdocs with versionning using mike on gitlab pages

I'm willing to deploy a new version of the doc each time I commit a tag on gitlab. I'm using mike for the mkdocs versionning. I want the versionning to be handle directly on the remote repository not locally. Locally, I perfom my changes but each…
Joy Jedidja Ndjama
  • 534
  • 7
  • 11
2
votes
2 answers

configuring image filepaths correctly in mkdocs

I have an issue with MkDocs not being able to find my images. The images are in a subfolder, called microsatsFigures, in my docs folder. So my /docs folder contains index.md, traces.md and the folder microsatsFigures which has the images. In my…
Hilary Miller
  • 31
  • 1
  • 2
2
votes
1 answer

How do you remove the previous and next buttons in mkdocs?

I am trying to remove the previous and next buttons in mkdocs but I don't want it to be hacky. I have read the docs and searched the web and haven't found anything other than some GitHub issues. Remove these buttons! Thanks!
Chris Bolton
  • 2,162
  • 4
  • 36
  • 75
2
votes
1 answer

How to embed a local pdf file in mkdocs generated website on github-pages?

I have a private repository with some pdf files among others. The content is however, made publicly available using MkDocs (material) and github-pages. I want to embed these locally available pdf files on the website (created with MkDocs). So far I…
CypherX
  • 7,019
  • 3
  • 25
  • 37
2
votes
0 answers

Proper way to reference ReadTheDocs page (with or without .html in path)

I have a github project called amrlib where I link to my ReadTheDocs pages in the main README. For some reason I now seem to need to use links without .html in them. However, at some point in the past the .html was required. I'm now wondering…
bivouac0
  • 2,494
  • 1
  • 13
  • 28
2
votes
0 answers

Configure logo for ReadTheDocs site using MkDocs engine

Maybe a missing feature; not sure. How would we go about adding the site/project logo top left in a ReadTheDocs site using the MkDocs engine? At https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#adding-a-logo (and some SO questions)…
Marcel Stör
  • 22,695
  • 19
  • 92
  • 198
2
votes
2 answers

to-be-continous Mkdocs gitlab-ci template, why variant usage?

To deploy pages on gitlab, we needs to add a "variant" include. Why it's an external yaml file and don't use the same template file with an option to (de)activate it ?
Cédric OLIVIER
  • 53
  • 5
2
votes
1 answer

How can I make mkdocs support Markdown documentations in multiple locations?

MkDocs is a great tool for documentation based on Markdown language. However, currently it only supports documentations in one specific location as this document shows (see mkdocs configuration): docs_dir The directory containing the documentation…
feelfree
  • 11,175
  • 20
  • 96
  • 167
2
votes
0 answers

command:error TypeError: unsupported operand type(s) for +: 'int' and 'str'

when I use this command pip install mkdocs mkdocs-materialand mkdocs serveto run a simple project ,it throws an errorTypeError: unsupported operand type(s) for +: 'int' and 'str': python version is 3.8.5, pip version ispip 21.1 from…
xianmiao lin
  • 21
  • 1
2
votes
1 answer

Add custom Jinja2 filters/tests to MkDocs

While writing a Jinja2 template for MkDocs, I need some processing that is not covered by the filters/tests available (specifically, I need date formatting, which is a recurring example for custom filters in Jinja2-related resources across the Web).…
Maëlan
  • 3,586
  • 1
  • 15
  • 35
2
votes
1 answer

How to make pages in MkDocs's side menu expandable?

I tried searching for this, but was unable to get any sort of answer that would be pointing to a solution. Let me start with some background first i suppose. My Goal: I'm currently figuring out how to get a decent automated documentation created for…
Pete
  • 41
  • 1
  • 4
2
votes
1 answer

Mkdocs material LaTeX not rendering in instant mode

I am trying to use KaTeX in Mkdocs Material theme. When the 'instant mode' is off, everything works fine. However, in the instant mode, only the KaTeX in the page I enter first is rendered, while the rest KaTeX (loaded when clicked on internal…
x4Cx58x54
  • 21
  • 2
2
votes
0 answers

How do I implement a search page on a mkdocs site?

I have a working search box in my nav bar, what I'd like to implement now is a search page, eg mysite/search.html - ideally so I can set up links to my site with mysite/search.html?q=QUERYSTRING An example of this working in practice is shown…
Allan Bowe
  • 12,306
  • 19
  • 75
  • 124
2
votes
0 answers

Bootstrap Navbar length mismatch with body content

I am using mkdocs default bootstrap theme (Bootswatch v4.1.3) to create a website that supports markdown. In the body I have created a large width table and due to that, navbar appears shorter than body, when we scroll to rightmost. Adding image…
deepaklearner
  • 151
  • 1
  • 6
  • 22
2
votes
1 answer

How can I use codehilite and mermaid together?

We generate documentation using mkdocs with the material theme and until now have used the codehilite extension. I've now added mermaid using a method described here: https://github.com/squidfunk/mkdocs-material/issues/693 First, my markdown: #…
Henry Rusted
  • 379
  • 6
  • 15
1 2 3
…
19 20