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
0 answers

Fill login details of external site

I have application with angular where I have an input:

Open documentation

which calls method: redirect() { window.open(this.documentationUrl, '_blank');} this.documentationUrl holds the link of…
user122222
  • 2,179
  • 4
  • 35
  • 78
0
votes
1 answer

Allow CORS in mkdocs local build (Failed to load Cross origin requests only supported for schemes http, data, chrome, chrome-extension, https)

I am running into an issue specifically with font-awesome and search_index.json while building mkdocs locally with mkdocs build. I understand the issue and why it isnt working, but i am trying to distribute my documentation locally instead of using…
securisec
  • 3,435
  • 6
  • 36
  • 63
0
votes
1 answer

mkdocs: Using a custom python module to complement a plugin

I would like to write a plugin for mkdocs that allows to add a file of custom python code. Here is an example of plugin. I would like to put the module in the website's main dir, alongside the mkdocs.yml file, and declare that module in there,…
fralau
  • 3,279
  • 3
  • 28
  • 41
0
votes
0 answers

Mkdocs Warning: 404 GET require.js

I've worked using Mkdocs before but when I upgraded/re-installed Python, Pip, and Mkdocs, any contents made though Markdown does not show; the build is successful and shows my webpage through localhost but outputs no content from Markdown. Rather,…
karlmiguerez
  • 1
  • 2
0
votes
1 answer

How can I preserve / enforce formatting when converting a Markdown file to pdf?

How can I convert a Markdown file to PDF and preserve the code block formatting? The Markdown code JSON { "client_id": "string", "api_key": "string", "data": { as served up via Mkdocs looks like: EX_1 After converting the Markdown file to…
FunnyChef
  • 1,880
  • 3
  • 18
  • 30
0
votes
1 answer

mkdocs site doesn't exist after build on codeship

I'm trying to use codeship to automate building docs from a repository. After the Executing the command mkdocs build --clean I get a path to where my site folder is supposed to be. INFO - Cleaning site directory INFO - Building…
Joseph Kobti
  • 115
  • 7
0
votes
1 answer

Is there a cachebust variable in mkdocs templates?

Is there anything like {{ time() }} or even more ideally {{ sha1sum('main.js') }} which I could use as a cachebust parameter in my theme templates? Yes I'm aware of server side caching headers, but I don't have control of those.
mbarkhau
  • 8,190
  • 4
  • 30
  • 34
0
votes
1 answer

Variable modified in loop does not persist outside the loop

{% set title_org = nav_item.title.split(" ") %} {% set title_mod = "" %} {% for i in title_org %} {% if loop.index > 3 %} {% set title_mod = title_mod + ' ' + i %} {% endif %} {% endfor %} {{…
notalentgeek
  • 4,939
  • 11
  • 34
  • 53
0
votes
1 answer

how to write a function syntax in mkdocs

what syntax of markdown do I need to write the api like below. the html code is below: link
create_bootstrap_script
彭泽鑫
  • 99
  • 1
  • 2
  • 8
0
votes
1 answer

How do I add a link back to my main webpage from a page written with mkdocs?

I am building a general website that also has a documentation page. For the docs page I'm using mkdocs. I would like a link in the docs page, ideally in the top right corner, that goes back to my main webpage. I know how to put links inside the…
brendan8229
  • 47
  • 1
  • 2
  • 9
0
votes
0 answers

Subprocess kills parent process instantly

When I try to run mkdocs serve as a subprocess and use CTRL+C to quit the MkDocs server, the parent Python process quits instantly, too. Not even finally clauses or functions registered with atexit are called. try: os.system('mkdocs…
Niklas R
  • 16,299
  • 28
  • 108
  • 203
0
votes
1 answer

Markdown fails combining fenced_code and attr_list

I'm trying to write markdown files for mkdocs and want an id attribute with the pre tag, generated be fenced_code. If i use both extensions in combination there is no pre-tag but a p(aragraph tag): import markdown text = """# Welcome This is…
Andreas Müller
  • 210
  • 2
  • 10
0
votes
2 answers

mkdocs and markdown: base.css overwrites custom css

i'am new to mkdocs, here is what i'm trying to do: add a caption to images and use a css style to use a shorter margin-bottom i managed to install a python-makdown extension "captions", so if i use ![](../img/some.png) : my sub caption i'll get…
Andreas Müller
  • 210
  • 2
  • 10
0
votes
0 answers

Using mkdocs Github pages are not updating but gh-pages branch has the latest changes

There are a few similar questions but none of the solutions mentioned in the other questions could solve my issue. I am using mkdocs to publish github pages. command I am using is mkdocs gh-deploy --clean This has worked correctly in the past. But…
Sambhav Gore
  • 555
  • 2
  • 13
-1
votes
1 answer

How can I insert an unordered list inside a note in Markdown without losing the note?

How to add an unordered list inside a note in Markdown without additional extensions? I tried the following syntax but the Note disappears and the unordered list appears without being enclosed in a note. Is there a workaround to insert a list into a…
Induja
  • 19
  • 3
1 2 3
…
19
20