mkdocs-material | Documentation

by squidfunk HTML Version: 9.5.27 License: MIT

X-Ray Key Features Code Snippets(2)Community Discussions(5)Vulnerabilities Install Support

kandi X-RAY | mkdocs-material Summary

mkdocs-material is a HTML library typically used in Utilities, React, Gatsby applications. mkdocs-material has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

Create a branded static site from a set of Markdown files to host the documentation of your Open Source or commercial project – customizable, searchable, mobile-friendly, 50+ languages. Set up in 5 minutes.

Support

Quality

Security

License

Reuse

Support

mkdocs-material has a medium active ecosystem.

It has 14194 star(s) with 2996 fork(s). There are 116 watchers for this library.

There were 6 major release(s) in the last 6 months.

There are 21 open issues and 1880 have been closed. On average issues are closed in 5 days. There are 10 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of mkdocs-material is 9.5.27

Quality

mkdocs-material has 0 bugs and 0 code smells.

Security

mkdocs-material has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

mkdocs-material code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

mkdocs-material is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

mkdocs-material releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

It has 9549 lines of code, 20 functions and 342 files.

It has high code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of mkdocs-material

Get all kandi verified functions for this library.

mkdocs-material Key Features

No Key Features are available at this moment for mkdocs-material.

mkdocs-material Examples and Code Snippets

Mkdocs is not found, but possible to uninstall on macOS

Python

Lines of Code : 6

License : Strong Copyleft (CC BY-SA 4.0)

Copy

sudo pip3 install mkdocs
sudo pip3 install mkdocs-material
sudo pip3 install matplotlib

mkdocs serve

Auto-build an Mkdocs documentation in Travis CI

Python

Lines of Code : 28

License : Strong Copyleft (CC BY-SA 4.0)

Copy

language: python # Set the build language to Python

python: 3.6 # Set the version of Python to use

branches: master # Set the branch to build from

install:
    - pip install mkdocs # Install the required dependencies

script: true # Ski

Community Discussions

Trending Discussions on mkdocs-material

Mkdocs "can not display mermaid in the right way"

mkdocs meta-tags for opengraph

How do I specify custom primary color for mkdocs-material?

How to add MkDocs Material icons to templates?

Can GitLab pages be used for review apps on a mkdocs project?

QUESTION

Mkdocs "can not display mermaid in the right way"

Asked 2022-Mar-12 at 13:10

I try to use this theme plugin to display the graph

Link: https://squidfunk.github.io/mkdocs-material/reference/diagrams/?h=mermaid

the settings file:

...

ANSWER

Answered 2022-Mar-12 at 13:10

This was part of the insiders offer at your time. If you upgrade your mkdocs-material version it should work.

https://squidfunk.github.io/mkdocs-material/insiders/

Source https://stackoverflow.com/questions/70842490

QUESTION

mkdocs meta-tags for opengraph

Asked 2021-Jul-12 at 21:50

I would like to have an image preview when sharing links to my mkdocs documentation, hosted and built by RTD. I need to override the HTML header of the site and add an open graph protocol.

After some investigation, I found a few resources on HTML overrides for the Material theme:
https://squidfunk.github.io/mkdocs-material/reference/meta-tags/
https://rohancragg.co.uk/writing/social-media-sharing/
A plug-in like this for sphinx would be ideal:
https://github.com/wpilibsuite/sphinxext-opengraph

Unfortunately, I am using mkdocs and the readthedocs theme for my documentation and apparently, this does not fully support the meta extension:

Here is what I did:
I was able to add the extension and link a main.html override containing the open graph protocol. The link-sharing worked just fine! Unfortunately, now all pages in my doc just render in white. I don't get an error message in the built log (below), or I am overlooking something.
Looking at the raw html, I can see that the header now only contains the opengraph protocol and the body is empty:

...

ANSWER

Answered 2021-Jul-09 at 19:11

I was able to solve this after some more research. The reason why it didn't work was because I didn't place the

Source https://stackoverflow.com/questions/68313618

QUESTION

How do I specify custom primary color for mkdocs-material?

Asked 2020-Nov-19 at 17:53

I am using mkdocs-material for creating a documentation website. How do I specify my own custom primary color and secondary color?

I dont want to use any of the existing colors

...

ANSWER

Answered 2020-Jul-21 at 17:56

I found the way.

First you create an extra.css in docs/stylesheets/

Source https://stackoverflow.com/questions/63017898

QUESTION

How to add MkDocs Material icons to templates?

Asked 2020-Jul-30 at 18:38

MkDocs Material comes packaged with many icons, and makes it very easy to use them in markdown. You can put short-codes anywhere in your Markdown, and they render perfectly.

...

ANSWER

Answered 2020-Jul-30 at 18:38

Author here. I've just added a section to the documentation for how to use icons in templates: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#using-icons-in-templates

Source https://stackoverflow.com/questions/63135869

QUESTION

Can GitLab pages be used for review apps on a mkdocs project?

Asked 2020-Mar-09 at 13:41

This answer by @joki to a previous question suggests that it is possible to deploy each active branch in a GitLab repo to a dynamic environment, by giving browsable artifacts a public URL.

Trying this out with a mkdocs material project, I've found two issues.

Firstly, if the GitLab repo is within a group or a subgroup the URLs in the .gitlab-ci.yml file needs to be something more like this:

...

ANSWER

Answered 2020-Mar-09 at 13:41

You can see the URL you need in the »Browse« button of the build step in your pipeline.

Does this work?

Source https://stackoverflow.com/questions/60530676

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install mkdocs-material

Material for MkDocs can be installed with pip:.

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: