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
45
votes
4 answers

Permission denied to github-actions[bot]

I'm using mkdocs to generate documents for my project,now I can't deploy those docs to Github pages,it tell me: remote: Permission to XXX.git denied to github-actions[bot]. fatal: unable to access 'XXX': The requested URL returned error: 403 This…
forestbat
  • 453
  • 4
  • 10
17
votes
1 answer

Use static html in mkdocs

Is there a solution to use HTML in markdown files - or an option to display a whole extra page that is pure HTML? Problem: I want to include an html snippet in my mkdocs generated wiki that uses some inline Javascript. Tried: I have been searching…
Will Occam
  • 171
  • 1
  • 3
14
votes
3 answers

Global variables in MkDocs

I have a documentation project made with MkDocs. I would like to define global variables in the configuration file (mkdocs.yml) to be used in the markdown pages (*.md). Reading this issue, it seems it can be done by including an extra configuration…
Boni García
  • 4,618
  • 5
  • 28
  • 44
9
votes
1 answer

Extending Airflow Web UI and adding Static HTML pages and CSS

I have been trying to extend the UI of airflow by adding airflow plugins. My goal is to be able to show internal project documentation from airflow. I am using MKDocs for this. I have followed the airflow documentation…
Natasha
  • 175
  • 1
  • 3
  • 12
9
votes
1 answer

Mkdocs hyperlink not working in static pages

I'm trying to build a documentation with mkdocs. The problem is that the links in the static created pages are not working. Instead of going to [folder]/index.html I'm presented with the following page like in the following image The problem…
Joseph Kobti
  • 115
  • 7
8
votes
1 answer

MkDocs - how to create Table Of Contents from mkdocs.yml inside index.md

I am looking for a way to automatically include TOC within .md files. This sounds like something trivial and was available in GitBook and other static website generators for ages. Is there any extension supporting it?
Meir Tseitlin
  • 1,878
  • 2
  • 17
  • 28
8
votes
0 answers

Hosting html with Auth on Firebase?

I am using Mkdocs for Generating Documentation and would like to host with firebase but with Authentication. I have hosted html without Authentication on firebase and didn't find any solution for authentication. Any help is appreciated.
Anurag
  • 1,013
  • 11
  • 30
7
votes
0 answers

When do I get a mkdocs error on build command of Docker?

I just started trying out Docker and I'm trying to resolve their first tutorial. When I run the command docker build -t docker101tutorial I get an error saying ERROR [build 2/2] RUN mkdocs build. Does anyone know how to solve it or has run to it…
Vasko LoL
  • 93
  • 3
7
votes
0 answers

Relative links (to headings) in mkdocs with markdown_include.include

I'm not sure it's even possible to solve this problem - but I'd ask anyways: I'm working on a python project using mkdocs for the documentation. The project structure (simplified) looks roughly like this: ./ |-- docs |-- index.md |--…
Balduin
  • 415
  • 4
  • 11
7
votes
2 answers

How do I specify custom primary color for mkdocs-material?

I am using mkdocs-material for creating a documentation website. How do I specify my own custom primary color and secondary color? I dont want to use any of the existing colors
Bilal Fazlani
  • 6,727
  • 9
  • 44
  • 90
7
votes
2 answers

Auto-build an Mkdocs documentation in Travis CI

How exactly do I automatically deploy my Mkdocs documentation in Travis CI?
Richie Bendall
  • 7,738
  • 4
  • 38
  • 58
7
votes
1 answer

Can I use external themes with MkDocs on readthedocs.org?

I switched from the included ReadtheDocs theme to the bootswatch United theme for my project. I did a pip install mkdocs-bootswatch for this theme, and changed theme: readthedocs to theme: united in my mkdocs.yml file. However, although the project…
AnnB
  • 73
  • 4
6
votes
2 answers

How to embed HTML iFrame into mkdocs/material?

I'd like to embed an HTML file into an MkDocs/Material page. I'm trying something like what's below, but getting a 404 error. Any idea of the right way to do this?
For what it's worth, a…
AJ Friend
  • 703
  • 1
  • 7
  • 16
6
votes
1 answer

Can GitLab pages be used for review apps on a mkdocs project?

This answer by @joki to a previous question suggests that it is possible to deploy each active branch in a GitLab repo to a dynamic environment, by giving browsable artifacts a public URL. Trying this out with a mkdocs material project, I've found…
snim2
  • 4,004
  • 27
  • 44
6
votes
2 answers

manifest.json failing to load icon files

So my setup is the following: A static website (mkdocs) deployed at https://sub.domain.com/folder/ in Azure Blob storage, running on Kestrel. testing locally at localhost:port without a subdomain and folder.
Stan
  • 121
  • 2
  • 8
1
2 3
…
19 20