307 questions
1
vote
1
answer
55
views
Preview mkdocs-macros built markdown content before html render?
I'm converting some content/code-repetitive pages in an MkDocs project to template builds using `mkdocs-macros`. I have generally working parent-child templates using extends and blocks, but am ...
- 1,691
2
votes
1
answer
235
views
Documenting type alias of template instantiation in a header with a Doxygen
I have this include/Interface.h file which looks something like this:
/**
* @file Interface.h
* @brief This is an interface file.
*/
namespace MyNamespace {
/**
* @brief Template struct ...
- 51
1
vote
1
answer
83
views
mkdocstrings - resolve variable type hint into actual type hints
I want to assign a set of type hints to a variable, for re-use across various functions. But this should be internal-only, I don't want to present this variable in my library documentation. Can I get ...
- 63
0
votes
0
answers
128
views
Mkdocs - filter by two criterias
Currently I am playing around with Mkdocs (with material) and it seems that there are two options OOTB, how to filter markdown files:
Navigation (created automatically through folder hierarchy)
Tags (...
- 1,561
0
votes
1
answer
156
views
Material for MkDocs - formatting to two panels
I use Material for MkDocs. Is it possible (perhaps with some plugin or Markdown extension) to render two blocks so they show as two panels next to each other? Each panel would occupy half of its ...
- 12.4k
0
votes
0
answers
148
views
Generating a custom index page with meta data in mkdocs/mkdocs-material
I have a project using mkdocs-material where I have a bunch of documents and I want to generate a custom index page that contains a table listing specific meta data provided in each of the documents.
...
- 18k
0
votes
0
answers
59
views
CLion autoformatting rules for mkdocs markdown files
Environment
I have a mkdocs project to write my documentation using markdown. I'm using CLion to edit and write the markdown files (since CLion is also my main development tool and I wanted to avoid ...
- 748
0
votes
1
answer
100
views
Table Header at 45 degrees
I would like to have table headers at 45 degrees like this:
How can I configure mkdocs to put the headers at 45 degrees?
I am using material but would be willing to use another style.
How can I ...
- 10.2k
2
votes
0
answers
114
views
How to combine MkDocs with pybind11 modules?
I'm trying to generate a documentation site for a Python API which is created with pybind11 using MkDocs. This API has also a .cpp API which is generated well.
This is my C++ common header code:
#...
- 51
0
votes
1
answer
81
views
How to escape excessive brackets and pipes {|([^])} in Markdown?
I have been attempting to display this bit of text below on my page, using mkdocs, but due to the combined use of brackets and pipes, my page will not display the full text string here:
{ "\\|([^...
0
votes
1
answer
471
views
Set a custom icon for a social link with Material for Mkdocs
I am trying to make a website with MkDocs and Material.
I am adding a social link that is supposed to use a custom icon I saved into the project's root directory.
MkDocs is trying to load the image ...
0
votes
0
answers
52
views
Custom jinja filter using python pandas is returning only sometimes returning correct information?
I'm building a site with the Material theme for MkDocs. I've added the following custom filter:
import pandas
def csv_to_html(csv_path):
return pandas.read_csv(csv_path).to_html()
I'm trying to ...
- 1,166
0
votes
1
answer
152
views
MkDocs not seeing extra_templates?
I'm getting started using MkDocs. I've defined a custom template at docs/templates/my_template.html. I've specified the template in mkdocs.yml according to this documentation:
extra_templates:
- ...
- 1,166
0
votes
1
answer
381
views
Generate Markdown file without __init__.py in subfolders with MkDocstrings
So this is my project structure :
- packages
--pkg1
---subpkg1
----wrkpkg1
------file1.py
----wrkpkg2
------file2.py
----__init__.py
mkdocs.yaml:
plugins:
search
glightbox # lightbox ...
0
votes
1
answer
236
views
Issue with Cyrillic Anchors Not Scrolling to Headers in MKDocs Material
Problem Description
I’m using Obsidian and have set up a vault where my notes reference each other using specific headers. When I try to follow a link (using anchors) to a header on another page, the ...
- 11