MkDocs
MkDocs is a fast, simple and downright gorgeous 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.
Here are 377 public repositories matching this topic...
I am aware that this is not a supported scenario, but any help is appreciated regardless.
My name is Dalton and currently developing a readthedocs docker image for streamlining self-hosting for the wpilibsuite organization. Following the [installation steps](https://do
-
Updated
Jun 21, 2020 - TypeScript
deis logs -a <app_name> --lines -1 not spitting out all logs since app launch. As a workaround you have to supply an arbitrarily large number i.e - deis logs -a <app_name> --lines 10000.
-
Updated
Jun 21, 2020 - TypeScript
Currently, the syslog on the atomic hosts is too noisy, very hard to identify what's good/bad. Look into options to collect and display all stack logs.
Hello @NiklasRosenstein,
I like this library a lot, I find it so useful. Though, I would like to be able to include images in both README.md and index.md. Let me explain:
PROBLEM
- Let say README.md is at the project's root, as usually.
- I have a folder named sources, which is also specified at the pydocmd.yml as
docs_dir: sources. - Finally, I specify
`pages: - Home: index.m
From #82.
Instead of a warning we could simply add a debug log with the path to the used template using its filename attribute, though with the current code each handler must do it.
Also we have no control within the Jinja rendering: when we {% include "template.html" %} we can't even issue a debug log to tell which one was picked up, so I'm not sure about the usefulness of just logging
It would be great if there was a function in the theme handler in which I could modify the HTML before it's converted to PDF, for example to add a title page.
(At the moment, I tried to add a title page by combining the output with a pre-made PDF for the title page using Ghostscript, but the problem is that Ghostscript ruins all the named destinations links, so internal links won't work. Would
Clarity in README.md
markdown_extensions:
- toc:
# permalink: True # renders ¶ sign
permalink: '#'Renders permalinks next to h elements but they're static-always-on. The more common behavior found around the internet is they're only displayed on hover.
Inspiriation:
- Some of my devs who uses this awesome tools initially complains about the directory structure of Ansible related stuff and also on how to go about it.
- It would be nice to have some documentation in place for the same.
@theskumar your take?
-
Updated
Jun 16, 2020 - Ruby
-
Updated
Oct 9, 2019 - R
-
Updated
Apr 27, 2016
-
Updated
Mar 28, 2020 - Python
.pages.arrange is a convenient layout overriding mechanism. It'd be great if you can make it work a little more like the nav directive. e.g.
arrange:
- Home: README.md
- Background: background-materials-directory
The first form (<title>: <file.md>) is identical to nav. The second form would save us from having to create a .pages file with a title directive just to override th
-
Updated
May 1, 2017 - Jupyter Notebook
Oooh wouldn't this be so cool... :)
So you mention the ability to use git submodules to include the mkdocs.yml + docs in other repositories. If these sub-repos (let's call them) are standalone mkdocs directories without any developer code, this works.
However, let's say you have a bunch of dev code in a sub-repo, but you also want to have the documentation live there in a 'docs' folder. An
-
Updated
Jun 6, 2020 - Python
Documentation states that the payload of heartbeats and reports contains an attribute params delivering an array of values. But my Gateway instead sends an attribute called data of type object. Should the documentation be changed?
-
Updated
Nov 10, 2018
I tried to use the recommended image by the documentation here https://github.com/emlid/emlid-docs/blob/master/docs/autopilots/common/ardupilot/configuring-raspberry-pi.md, however ran into the following issue: emlid/pi-gen-navio#4
Looking a bit deeper, navio-stretch is the default branch not navio-buster, I believe the navio-buster link has been updated to the d
-
Updated
Jun 13, 2020 - Python
I'm considering switch to mkdocs from sphinx, but cannot solve the navigation issue.
This is a sample built with sphinx + recommonmark+ readthedocs theme+ readthedocs host
readthedocs theme should support