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

Getting auto appending snippets working with mkdocs

Just discovered mkdocs and really like it. I am currently porting online done in a proprietary tool into it. The only stumbling block I've had is implementing auto-appending snippets. I was able to implement abbreviations as described…
oceanclub
  • 477
  • 1
  • 4
  • 13
0
votes
2 answers

Force GitHub pages to render numerical lists sequentially instead of restarting?

I noticed that when GitHub pages with mkdocs have text or images in between numbers it ignores the numbering in the source document and instead restarts numbering. See here for an example of this. Is there a way to force mkdocs to render the numbers…
Grant Curell
  • 1,321
  • 2
  • 16
  • 32
0
votes
0 answers

mkdocs navigation pointing to url docs

I currently off my documentation within the same directory as my mdocs.yml file, but I wonder if can add documentation from a different location possibly by URL? site_name: 'School Supplies' site_description: '5th grade school supplies for the…
Paul Blart
  • 183
  • 1
  • 3
  • 12
0
votes
1 answer

How to setup gh-pages correctly

I created successfully a very basic gh-page on https://makanu.github.io. The Repo just includes a README.md, a LICENSE and the most basic index.html I could imagine. My problem is now, that I have a another Repo which includes a gh-pages branch…
MaKaNu
  • 762
  • 8
  • 25
0
votes
0 answers

Mkdocs with material theme: is it possible to change site name according to language?

I'm making a documentation site using Mkdocs and mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/getting-started/). I need to make a multilanguage project ('pt' and 'en' for now). What i'm in need is a way to change the site name…
Marlony Gabriel
  • 11
  • 2
0
votes
1 answer

Built in with MkDocs in Readthedocs

I am preparing documentation using MkDocs and trying to generate the documentation using readthedocs. I followed the user guide but readthedocs does not seem to communicate with my uploaded .md files in my GitHub project. Instead of reading my…
Ray
  • 1
  • 1
0
votes
0 answers

Serving mkdocs site with nginx

could anyone point in the right direction on how to serve an mkdocs site on centos using nginx? Or maybe there is a better way of doing it? Any info is appreciated, thanks.
Arnas
  • 27
  • 7
0
votes
1 answer

Apply CSS elements to only some pages in Mkdocs

I'm using mkdocs with the material theme to generate documentation. For certain pages I would like to have section numbers. I'm using the following to generate section numbers. is there a way to make the headings, sections and subsections numbering…
agf1997
  • 2,668
  • 4
  • 21
  • 36
0
votes
1 answer

Stuck with the PlantUml within Mkdocs

I'm configuring the PlantUML plugin for my MkDocs installation and I'm stuck. I cannot configure mkdocs.yml correctly. I get either configuration errors or parsing errors every time I enable this plugin. The errors are: ERROR - Config value:…
Igor Shakhbazyan
  • 3
  • 5
0
votes
2 answers

Right way to change mkdocs markdown toc title "table of contents"?

I'm using mkdocs with material layout and toc markdown extension for adding a toc to the right for a documentation project. I use up42's wiki as a template for my wiki. I would like to change the title "Table of contents". The toc markdown…
do-me
  • 1,600
  • 1
  • 10
  • 16
0
votes
1 answer

Documentation keeps showing old version (readthedocs)

I updated my documentation, I even built it from scratch again and uploaded the corresponding "site" files to github, but no matter what I try, only the oldest version of my doc shows up. For example, in this markdown file, the example should…
Johncowk
  • 342
  • 1
  • 16
0
votes
1 answer

How can I get MkDocs with Arithmatex and MathJax to recognize \\[ ... \\] as display math delimiters?

I'm using MkDocs 1.2.2 with MathJax 3.2 via Arithmatex from the pymdown-extensions. I'm trying to get Arithmatex to recognize math inside \\[ and \\] (instead of the default \[ … \]) as display math. Starting with a basic…
mhucka
  • 2,143
  • 26
  • 41
0
votes
1 answer

What's exactly wrong with this mkdocs.yml configuration?

I am working on a MkDocs project and trying to tweak the markdown_extensions setting. Please look at it and tell me what's wrong, since I really can't find the error. Note: I have installed the required libraries, so that isn't the problem. -…
Danijela Popović
  • 92
  • 8
0
votes
1 answer

Mkdocs get current url ( Browser connected:)

So I'm trying to configure Mkdocs for my documentation, I've different folders and each one has got tasks documentation for that job For eg - Developer (index.md, about.md), Marketing (index.md, about.md), HR(Index.md, about.md) Now I need to create…
Kavi Harjani
  • 661
  • 5
  • 15
0
votes
0 answers

Gitlab static mkdoc website does not work. What can be the reason for it?

I want to include a Mkdoc into my gitlab repository. I followed the instruction on Mkdoc, but the website is not showing up. The error message ist displayed on the screenshot below. I included the .gitlab-ci.yml file in the root file. This is the…
RainerWinkler
  • 13
  • 3
1 2 3
…
19 20