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
3
votes
2 answers

How to add a landing page to a mkdocs doc site using mkdocs-material?

I'm trying to create a landing page similar to how mkdocs-material's doc site (https://squidfunk.github.io/mkdocs-material/) has. I am using mkdocs-material for my docs site.
Farhan Sheik
  • 33
  • 2
  • 4
3
votes
1 answer

How to install plugins in mkdocs-material docker image

Hello Stackoverflow community, I use mkdocs with continous integration (drone-ci) to build and deploy documentation. I use the docker image mkdocs-material from squidfunk, but I need some plugins on top of it. I tried to build my custom image with…
facteurpat
  • 51
  • 1
  • 3
3
votes
1 answer

Display Application Source Code Files in MkDocs Code Block

How can I display existing source code files within MkDocs? I want to include the files directly from another GitHub repository in code blocks without reformatting them so updated files will be shown in the MkDocs document. sample_code.py def…
flywire
  • 1,155
  • 1
  • 14
  • 38
3
votes
0 answers

Issue with mkdocs and PIP pip-20.0.2

With the new version of PIP there is something odd happening. Despite this line: Successfully installed Markdown-3.2.1 livereload-2.6.1 lunr-0.5.6 mkdocs-1.1 nltk-3.4.5 tornado-6.0.4 when I run this: mkdocs --version I…
David Gatti
  • 3,576
  • 3
  • 33
  • 64
3
votes
0 answers

How to convert rather complex reStructuredText (rst) to markdown?

I would like to convert the user guide of Robot Framework which is written in RST (restructuredtext) to Markdown to be able to host this great peace of work as a mkdocs site. I have already tried to convert the html version of the guide (see here)…
Wlad
  • 2,866
  • 3
  • 28
  • 42
3
votes
0 answers

Gatsby/Hugo/MKDocs for markdown docs inside React SPA with dynamic functionality

I need to build an website that has dynamic functionalities - having a search and posting as well as receiving data from a RESTful API. We have decided to go with with React.js for the front end. We also need documentation in the app which will be…
Milda Nor
  • 61
  • 1
  • 7
3
votes
1 answer

Embed images in Python documentation

I have a python project that I want to create the documentation... In this documentation, it is crucial allowing embedding images. Also, I would like to not create a separate file. In others words: the *.py file would contain both the script and the…
guilhermecgs
  • 2,913
  • 11
  • 39
  • 69
3
votes
2 answers

Mkdocs eliminate copy paste in files

Can I somehow include a file into a file in mkdocs? I do not want to copy paste the same sections again and again. Thanks
doktoric
  • 109
  • 2
  • 10
3
votes
1 answer

mkdocs command not found on OSX

I'm following the mkdocs setup process here: http://www.mkdocs.org/#installation I'm not able to get mkdocs to do anything past the install on my local machine. I've installed the latest python and pip. I've verified the mkdocs package is installed,…
George Ortiz
  • 97
  • 2
  • 9
2
votes
0 answers

Mkdocs with README as index containing images with broken links

I've been trying to build a doc site with Mkdocs with doc_dir=docs/. Let's say I would like to use my README.md contents for the homepage. The contents of this file are copied into docs/index.md. This README happens to contain links to images, which…
Mo Kanj
  • 107
  • 7
2
votes
1 answer

How to use Fontawsome Pro icons in mkdocs material

I have purchased a License for the Fontawesome Pro Icons package and was wondering how I can use the pro library kit in mkdocs material? I currently use the free fonts like this, for example: :fontawesome-solid-user-secret: But I would like to use…
Ronny vdb
  • 2,324
  • 5
  • 32
  • 74
2
votes
1 answer

How to highlight code block with material mkdocs package?

I am using material mkdocs package and I want to to highlight lines 7-31 of a JSON code block and I am not sure how to do it. I been have looked through the documentation and have tried many things for a while and nothing has solved my problem. Does…
AugustusCaesar
  • 175
  • 2
  • 14
2
votes
0 answers

Document more than one repos with MkDocs

I got a special situation where I have a few Django packages that work closely together, and I want to document them together at one place. medux-common: common used models, views, etc. medux: main application medux-online: web interface for…
nerdoc
  • 1,044
  • 10
  • 28
2
votes
0 answers

mkdocs: How to link to the same images in ./README.md and ./docs/INDEX.md at the same time?

I have a README.md file in my project's root folder. The README.md contains links to images like this: ![image.jpeg](docs/media/image.jpeg) Now, in my docs folder, I have my index.md file referencing my README.md as follows (making use of mkdocs's…
Andi
  • 3,196
  • 2
  • 24
  • 44
2
votes
1 answer

Document versioning in monorepo

Background: I have one repo with multiple subdirectories. e.g Myrepo: Foo Readme.md Changelog.md Bar Readme.md Changelog.md Each of the subdirectory has its own version tag in Github. e.g Foo v1.0.0 Bar v2.0.0 I'm currently exploring an…
ChrisJ
  • 21
  • 2
1 2 3
…
19 20