Stack Overflow
Stack Overflow

Questions tagged [mkdocs-material]

27 questions
2
votes
1 answer

How to use Fontawsome Pro icons in mkdocs material

I have purchased a License for the Fontawesome Pro Icons package and was wondering how I can use the pro library kit in mkdocs material? I currently use the free fonts like this, for example: :fontawesome-solid-user-secret: But I would like to use…
Ronny vdb
  • 2,324
  • 5
  • 32
  • 74
1
vote
4 answers

mkdocs: how to attach a downloadable file

I have a mkdocs project that resembles the following: project ├─mkdocs.yml ├─docs │ ├─home.md │ ├─chapter1.md │ ├─static ├─file.ext ├─image.png I am trying to find a way to "attach" file1.ext to the build, for instance as a link in…
deponovo
  • 1,114
  • 7
  • 23
1
vote
0 answers

Horizontal scrollbar on wide image in MkDocs

I would like to display a wide image full height but with a horizontal scrollbar. This works in JSFiddle But it doens't in MkDocs HTML
Wouter Van Ranst
  • 521
  • 4
  • 14
1
vote
1 answer

MkDocs with Material theme does not display the Table of Contents of a page in the right sidebar of the screen

I can not get the table of contents of a page to appear on the right side of the browser screen MkDocs 1.4.2 Python 3.10 Material Theme 8.5.11 Windows 10 Browsers Firefox and Edge I set up a minimal MkDocs directory with mkdocs.yml as: site_name:…
DJFM
  • 11
  • 1
1
vote
0 answers

Material for mkdocs override index not showing collapsible nav

Everything seems to work except for the collapsible navbar when I override the default index page for Material for Mkdocs. All that appears is the darkened screen: It DOES work on the default Mkdoc sections, so I think I'm missing something in my…
chillingfox
  • 131
  • 9
1
vote
2 answers

Removing credits from mkdocs material

In mkdocs with material theme, how I can remove credits at the bottom. Made with Material for MkDocs Is there any settings in mkdocs.yml for this? Gone through documentation(https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/),…
Om Sao
  • 7,064
  • 2
  • 47
  • 61
1
vote
0 answers

How do I theme external hyperlinks differently with mkdocs?

I am using mkdocs with material theme and I am looking for a way to make all external links render differently than internal ones, so people will know when they point for external resources. Wikipedia is a very good example of site that does…
sorin
  • 161,544
  • 178
  • 535
  • 806
0
votes
2 answers

Can I influence the order of directories and pages in mkdocs/mkdocs-material manually?

In this example, I have a book-like documentation and it has three chapters: Introduction Basic Use Advanced Use These would go into separate directories (with sub-pages each ...). The file layout would look like this: doc/ advanced-use/ …
amenthes
  • 3,117
  • 1
  • 32
  • 38
0
votes
0 answers

MKDocs rendering apostrophes in Markdown as ’

I am creating an MKDocs 1.4.3 (running on Python 3.11.2) static site with the MKDocs Material theme. The strange thing is that apostrophes like ' are being rendered as ’ when I serve the rendered site locally with the mkdocs serve command. For…
hpy
  • 1,989
  • 7
  • 26
  • 56
0
votes
1 answer

Can I write mkdocs-material docs in HTML?

I use mkdocs-material and want to author the whole documentation in HTML. So basically instead of using Markdown # Title Paragraph ## Subtitle Another paragraph I want to write the same semantic with basic HTML…
enkryptor
  • 1,574
  • 1
  • 17
  • 27
0
votes
1 answer

mkdocs static app not rendered properly when deployed using azure pipelines on static webapp

I have created a mkdocs static website using mkdocs-material theme. It works perfectly fine on local machine and website is rendered properly using http://127.0.0.1:8000/ Next when I deploy it using Azure pipelines, the deployment (build and deploy)…
Sumit Pawar
  • 23
  • 5
0
votes
0 answers

How to combine mkdocs-materials and bootstrap 5 to work together

I have been learning both Material for MkDocs and Bootstrap 5 in unison. One day, I said, "Self, how come you can't take all of the features of Bootstrap 5 and make them available within Materials for Mkdocs?" So reading the documentation of Mkdocs…
Louis Preston Thornton III
  • 302
  • 1
  • 2
  • 12
0
votes
0 answers

Why are code snippets uncopyable when using "mkdocs build"? with mk-docs Material

I found a post with the same issue, but the solution is not working for my issue. I have the same issue than the original post. In "serve" I have the copy Button, but in "build" i don"'t have it. (it was working in v8.x) The…
Jungledede
  • 1
0
votes
0 answers

how to write DRY documentation with code examples in python?

I am writing documentation for a package that I am creating and I need to put code examples within the SDK in many places, what is the best way of doing this so it is DRY, automated, and tested easily? To write code documentation I am basically…
AugustusCaesar
  • 175
  • 2
  • 14
0
votes
0 answers

how to create documentation for a big python Enum class with mkdocs?

I have a big python enum class with many attributes, and I am wondering how I can generate documentation for it because if I wrote the docstrings for all 100+ attributes it would take a while and then be hard to maintain. I am currently using…
AugustusCaesar
  • 175
  • 2
  • 14
1
2