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

MkDocs - Have a file use a specific template

I’m probably not understanding something fundamental to Jinja and/or MkDocs but hopefully someone can point me in the right direction. I’m building a static website and using MkDocs. I need to have a landing page, some documentation pages and some…
MrBubbles
  • 405
  • 2
  • 7
  • 19
0
votes
1 answer

Is there a place to find CSS files to customize MkDocs' Material Theme?

I currently use MkDocs together with the Material Theme, to create nice looking wiki and documentation pages. However, I would like to customize the Theme to make it generally darker, as I'm not a big fan of bright white backgrounds. But sadly am I…
Andre_601
  • 87
  • 8
0
votes
1 answer

How to implement a plugin in MKDocs project?

UPDATE!!!! Watch the indent! My plugin section was indented in my code editor so it read as part of the package theme. Now that I have at least one of my plugins working, I feel somewhat sane. Now on to debug the other one... Thanks and leaving this…
JSN
  • 1
  • 5
0
votes
1 answer

Render superscript in mkdocs

Hello I am using Typora as my markdown editor and mkdocs for building the documentation project. While I am using to denote superscript in markdown syntax as service_command ^string,mandatory^ It shows perfectly correct in Typora. But when I build…
bhaskar das
  • 175
  • 4
  • 20
0
votes
4 answers

In MkDocs / Material, is it possible to put the table of contents on the left?

I'm using MkDocs with the Material theme. I'd like to build a site that looks a little like the Stripe API docs. By default, the Material theme puts .md documents in the sidebar on the left, and the headings withing those documents in a Table of…
ccleve
  • 15,239
  • 27
  • 91
  • 157
0
votes
1 answer

How to implement a good search system for a set of html pages generated with Mkdocs?

I'm using Mkdocs for creating articles (sets of static HTML pages). The problem with these docs is that the search system created by Mkdocs is very basic, retrieving articles pretty randomly, based on their mere presence in an article's text, and no…
CyberHead
  • 41
  • 2
0
votes
0 answers

Setting non string variable using PyYaml

I am using mkdocs system which is configured using yaml file, parsed via PyYml. I want to be able to specificy environment variable in its mkdocs.yml which is not possible in mkdocs ecosystem, but workaround exists using PyYml special…
majkinetor
  • 8,730
  • 9
  • 54
  • 72
0
votes
0 answers

Mkdocs theme 'Material' not working on mac os

i have been trying everything to get the Mkdocs theme 'material' to work on Mac os , i tried pip to install it and tried the repository cloning method too but still it does not work, the theme displayed is still default, i changed the mkdocs.yml…
Badr Douah
  • 63
  • 13
0
votes
0 answers

Printing a mkdocs-generated html page exposes links

When I print an mkdocs-generated html page (using google chrome in this case) the page explicitly prints the relative paths underlying a page link. For example: In mkdocs markdown file: to read more, visit this [page](../../more_info_page). On the…
GerryDevine
  • 111
  • 1
  • 9
0
votes
1 answer

Travis CI only uploads empty files from the build script

I'm currently trying to set up a documentation project on Travis CI. The build script uses the mkdocs library to generate markdown files to HTML files. I've tried now many hours to automate the deploy process with Travis CI. It should generate the…
Julian Schmuckli
  • 3,681
  • 11
  • 37
  • 64
0
votes
1 answer

Changing mkdocs code blocks with a custom theme

I am trying to add some html elements (like a div) in a custom theme, that wrap the mkdocs generated code blocks from the html output. mkdocs has their fenced code blocks with the triple backticks ``` stuff ``` and when it produces the html output…
yo76yo
  • 138
  • 7
0
votes
1 answer

Using extra CSS file with Mkdocs hosted by ReadTheDocs

I have written some custom CSS I would like to be included in a Mkdocs site hosted by ReadTheDocs. It is not working because RTD isn't serving the CSS file. I have a .readthedocs.yml file that asks RTD to use Mkdocs: version: 2 mkdocs: …
adam smith
  • 764
  • 7
  • 16
0
votes
2 answers

Deploying MkDocs documentation on Read the Docs using an organization's private repository

I am leaving my internship currently and I'm in the process of writing documentation for the summer intern that is taking over after I graduate. I have written all of my docs in Markdown using MkDocs and I'm ready to deploy them. My docs use the…
Justin Dunlap
  • 109
  • 1
  • 3
  • 12
0
votes
2 answers

What is the web-template used by many technical documentations on the web?

I found that following websites have the similary style (or theme or template): Keras Conda Thundersvm Chainer and so on... It looks lik many tech documentation websites use this style (or template). My question is: What kind of template is…
zchenkui
  • 139
  • 1
  • 10
0
votes
1 answer

Image size on Read the Docs (small images width)

I'm using MkDocs to generate docs using Markdown, and the theme Read the Docs. However, I'm having trouble getting small images from scaling up on mobile phones. I think this is linked to the Read the Docs CSS, but I'm having trouble understanding…
NBajanca
  • 3,544
  • 3
  • 26
  • 53
1 2 3
…
19 20