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

Customizing mkdocs css file

The links within the body change color once you hover and click on the link. Is there a way to have the color fix within the body of the mkdocs. I've been using some mkdocs documentation as an example, but so far I have this css: ` body { …
Paul Blart
  • 183
  • 1
  • 3
  • 12
0
votes
0 answers

OSError: [Errno 22] Invalid argument tryign to clone to github pages

Trying to upload files to github for the first time! everything seems setup ok when deploying to a website with MKDocs but not to github. I'm doing it by MKdocs gh-deploy with little success at all, I have never done this before so please take it…
Dave
  • 1,964
  • 1
  • 10
  • 11
0
votes
1 answer

Is it possible to configure mkdocs to use an additional pythonpath?

I have an package thats imported from the parent path everywhere. So i have to set PYTHONPATH enviromentvariable when i want to serve the docs for that package. Ive searched the Docs,stack overflow, google but couldn't find an solution to configure…
Christian U.
  • 1
  • 2
0
votes
1 answer

How can I track github pages with Google analytics 4 - measurement ID?

I have a repo with README.md as main page. This repo uses mkdocs for generating static site. Also, added Google Analaytics measurement ID to the mkdocs.yml for tracking the traffic on the static site. But my current requirement is to track the…
Navya Gopisetti
  • 1
  • 1
0
votes
1 answer

jinja2 how to retrieve the value of a variable to use it in an if statement jinja2

In order to create a template using jinja and markdown through mkdocs. I met this problem that is blocking me so far. I am using a variable in my if statement in order to fill a table with some specific information if the condition is true Let's say…
Jinja_dude
  • 404
  • 5
  • 20
0
votes
1 answer

Python 3.9 Errors with MKDocs Serve

After upgrading to Python 3.9, i'm getting these errors when running mkdocs serve I'm not a developer. I use MKDocs to build a documentation site and I wanted to upgrade the software, as a result I had to upgrade Python, pip, mkdocs and…
OSpecht
  • 1
  • 1
0
votes
1 answer

Mkdocs is not found, but possible to uninstall on macOS

My python versions are: python --version Python 2.7.9 python3 --version Python 3.8.5 I have downloaded pip. pip --version pip 20.2.2 from /Library/Python/3.8/site-packages/pip (python 3.8) pip3 --version pip 20.2.2 from…
Lilya
  • 495
  • 6
  • 20
0
votes
1 answer

How to stop material-mkdocs from trimming inlineCodeBlock whitespace?

(material-)mkdocs trims all whitespace from inline codeblocks like this one: : so the result looks like this :. I tried to specify a language using a shebang - as i though that this might be a dirty workaround - but it didn't help.
SaltyAimbOtter
  • 11
  • 3
0
votes
1 answer

How to add MkDocs Material icons to templates?

MkDocs Material comes packaged with many icons, and makes it very easy to use them in markdown. You can put short-codes anywhere in your Markdown, and they render perfectly. :smile: :material-account-circle: I can't seem…
conner.xyz
  • 6,273
  • 8
  • 39
  • 65
0
votes
2 answers

How to Automatically Number MkDocs Figures Sequentially

Can automatic sequential figure numbers be assigned in MkDocs? Something similar is also needed for code blocks to be numbered independently of the figures. [![CC-BY-SA_icon](/images/CC-BY-SA_icon.png "Attribution 4.0 International (CC BY 4.0)"){:…
flywire
  • 1,155
  • 1
  • 14
  • 38
0
votes
1 answer

Error parsing yaml with exclamation marks

Trying to use pyyaml to parse mkdocs.yml file. It contains a snippet like this: foo: emoji_index: !!python/name:materialx.emoji.twemoji When I run: with open("test.yml", 'r') as stream: try: print(yaml.safe_load(stream)) except…
AS_Butler
  • 281
  • 2
  • 12
0
votes
1 answer

Launch bash subshell and run commands in a script

I want to write a shell script that does the following: Activate pipenv virtual environment Runs mkdocs serve which starts a local dev server for my mkdocs documentation If I do the naïve thing and put this in my script: cd…
AS_Butler
  • 281
  • 2
  • 12
0
votes
2 answers

Exclude mermaid code blocks for highlighting with Codehilite (MkDocs)

I'm trying to generate a documentation from markdown files via mkdocs (with material) to publish on gitlab. My files include code blocks and mermaid diagramms, which are declarated the same (differentiated in the language). I would like to use…
mejoz
  • 135
  • 1
  • 6
0
votes
1 answer

Generate MkDocs pages in the browser

Is it possible to generate the pages for MkDocs dynamically/on-the-fly in the browser using JavaScript? In this case, the build process incl. all the required tools would not be necessary any longer. Since the build process generates static pages, I…
xiaoye
  • 58
  • 5
0
votes
2 answers

How do you convert a page to pdf and include an asset download link in markdown?

I have tried with different plugins listed on here: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#pdf--site-conversion But all of them always gives me the same error AttributeError: module 'mkdocs.utils' has no attribute 'string_types' My SO…
R. Vargas
  • 31
  • 1
  • 3
1 2 3
…
19 20