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

Unable to export external fonts within the MkDocs generated documentation

I have faced the problem I can't solve by myself, so I ask for the community help. I try to use our corporate fonts on my Mkdocs Material site. My steps: I've uploaded them (the .woff2 files) into the docs/assets/externals/fonts folder I edited the…
Igor Shakhbazyan
  • 3
  • 5
0
votes
1 answer

traefik V2 middlewares redirect-regex replace-regex not expanding variable

I've an issue wit a redirect-middleware in traefik V2. We want to add a trailing-slash to a sublocation and then remove the path with a PathPrefix-Rule to get correct paths from the docker service. (MkDOCS) We defined the rule in dynamic_conf.toml…
exa.byte
  • 155
  • 1
  • 12
0
votes
1 answer

Backstage Unable to use mkdocs to create Tech Docs for an existing component

I have enabled Github actions to create Tech docs after a commit. Below is the workflow file written to create Md files. But "techdocs-cli generate --no-docker --verbose" command fails with the below error. Can someone please help with the…
madhinigm
  • 11
  • 2
0
votes
0 answers

Change header size in Material for MkDocs

Hi I am using Material for MkDocs for my GitHub pages website. I want to change the size of the header to fit my logo (the logo needs minimum 85px width). However, when I do this and click on a link in the table of contents: the header now overlaps…
ajnabz
  • 297
  • 5
  • 25
0
votes
1 answer

MkDocs, mkdocstrings - attach only module docstring

When I want to attach the docstrings from bar module in my documentation, I put ::: foo.bar in the markdown file. It attaches all the docstrings in the bar file - module docstring and Bar class docstrings. When I want to attach just Bar classes…
DavidS1992
  • 823
  • 1
  • 8
  • 19
0
votes
0 answers

Material for MKDocs - print to PDF grouped by sections

I have an mkdocs site used for user guides for my company (using the material theme). I'm in QA so the coding side of things is fairly new to me. I was using mkdocs-prints-site-plugin to print all md files to one PDF, but users only want to print…
chowardqa
  • 1
0
votes
1 answer

Links work in MkDocs but not on GitHub repo

I am trying to put an image on my MkDocs webpage like this:
Fig1 (left), Fig2 (right)!
Which works fine. However, when I…
ajnabz
  • 297
  • 5
  • 25
0
votes
1 answer

In mkdocs, can I make generated markdown with headers be indexed?

I am doing a small site locally using mkdocs. The content is technical documentation, with several repeating and identical sections (not in a table). To give me flexibility I have put the repetitive information in an sqlite database, and at site…
MyICQ
  • 987
  • 1
  • 9
  • 25
0
votes
1 answer

Backstage: How to modify the docs theme and colors (MKDocs)

I want to change the techdocs theme and its colors on a global level in a Backstage app (not in each Docs folder). How can I achieve this? Example: Change the background color for all code snippets.
djflocko
  • 49
  • 1
  • 5
0
votes
0 answers

Conflicting dependencies

I recently installed mkdocs (with pip). It requires Spyder 4.2.5, and watchdog >=2. After installing Spyder, the installation process resulted in un-installation of the current watchdog I have installed (2.1.9), and the installation of a lower…
Brainiedude
  • 17
  • 2
0
votes
1 answer

Readthedocs tries to build mkdocs project with sphinx

I'm creating a python package for the first time and am having a lot of trouble getting my documentation to upload to readthedocs. I am using mkdocs to create my documentation. When I run the mkdocs serve command, my documentation loads just like I…
spatiate123
  • 1
0
votes
0 answers

Cannot COPY from previous stage in DockerFIle

This looks like a common issue so I checked a few SO posts but none of them solved my problem. Here is my Dockerfile: # MkDocs container FROM python:3-alpine AS build-env RUN apk add bash RUN pip install --upgrade pip RUN pip install…
Marcus Anthony
  • 71
  • 6
0
votes
1 answer

MKdocs-readTheDocs: How to set the Home page?

Yes, this is a rookie question, but its not clear to me from the documentation how to set up the home page. I get a 404 on the home page. Not sure what its missing. Any help is really appreciated. Using git pages to publish (user name removed), the…
Jorge
  • 25
  • 6
0
votes
1 answer

Error when starting a local server on Mkdocs Windows, how do I fix?

I am trying to edit some docs on github, here are my instructions: Clone the repo Create a virtual environment Install dependencies Start a local server I am able to 1 and 2 no problem, and 3 installs: mkdocs and mkdocs-material I run into an…
evie jugo
  • 1
0
votes
1 answer

Publish docs via GitHub Pages failed

Today I want to add a new page to my Github page. My repo worked well before. But when I add a new directory lsy/README.md to docs. Error shows. It just says Error reading page 'lsy/README.md': no such group. I cannot understand why. I added some…
Nicholas
  • 127
  • 1
  • 11
1 2 3
…
19 20