Personal tools
Skip to content. | Skip to navigation
The fastest markdown parser in pure Python, inspired by marked.
MkDocs Project documentation with Markdown 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. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions. Please see the Documentation for an introductory tutorial and a full user guide. Features Build static HTML files from Markdown files. Use Plugins and Markdown Extensions to enhance MkDocs. Use the built-in themes, third party themes or create your own. Publish your documentation anywhere that static files can be served. Much more! Support If you need help with MkDocs, do not hesitate to get in contact with us! For questions and high-level discussions, use Discussions on GitHub. For small questions, a good alternative is the Chat room on Gitter/Matrix. To report a bug or make a feature request, op
mkdocs-autorefs Automatically link across pages in MkDocs. Installation With pip: python3 -m pip install mkdocs-autorefs Usage plugins: - search - autorefs In one of your Markdown files (e.g. doc1.md) create some headings: Link to [Hello, World!](#hello-world) on the same page. This is a normal link to an anchor. MkDocs generates anchors for each heading, and they can always be used to link to something, either within the same page (as shown here) or by specifying the path of the other page. But with this plugin, you can link to a heading from any other page on the site without needing to know the path of either of the pages, just the heading title itself. Let's create another Markdown page to try this, subdir/doc2.md: We can [link to that heading][hello-world] from another page too. This works the same as [a normal link to that heading](../doc1.md#hello-world). Linking to a heading without needing to know the destinatio
mkdocs-get-deps An extra command for MkDocs that infers required PyPI packages from plugins in mkdocs.yml. Installation:Alternatively through MkDocs itself: pip install mkdocs-get-deps pip install mkdocs This command guesses the Python dependencies that a MkDocs site requires in order to build. It simply prints the PyPI packages that need to be installed. In the terminal it can be combined directly with a pip install command, as per the last example below: Usage:Alternatively through MkDocs itself: mkdocs-get-deps mkdocs-get-deps > requirements.txt pip install $(mkdocs-get-deps) mkdocs get-deps mkdocs get-deps > requirements.txt pip install -r requirements.txt pip install $(mkdocs get-deps) The idea is that right after running this command, you can directly follow it up with mkdocs build and it will almost always "just work", without needing to think which dependenci
A powerful documentation framework on top of MkDocs Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices. Check out the demo – squidfunk.github.io/mkdocs-material. Silver sponsors Bronze sponsors Everything you would expect It's just Markdown Focus on the content of your documentation and create a professional static site in minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs do the heavy lifting for you. Works on all devices Serve your documentation with confidence – Material for MkDocs automatically adapts to perfectly fit the available screen estate, no matter the type or size of the viewing device. Desktop. Tablet. Mobile. All great. Made to measure Make it yours – change the colors, fonts, language, icons, logo, and more with a few lines of
MkDocs Material Extensions NOTE: This project is now deprecated as MkDocs for Material now implements this logic directly. Users should migrate to using mkdocs-material's material.extensions.emoji.twemoji and material.extensions.emoji.to_svg in place of the respective materialx.emoji.twemoji and materialx.emoji.to_svg functions provided by this library. Markdown extension resources for MkDocs for Material Install Generally, just installing MkDocs Material will automatically install mkdocs-material-extensions. But if you had a need to manually install it, you can use pip. pip install mkdocs-material-extensions But make sure you've also installed MkDocs Material as well as this won't work without it. pip install mkdocs-material Inline SVG Icons MkDocs Material provides numerous icons from Material, FontAwesome, and Octicons, but it does so by inlining the SVG icons into the source. Currently there is no easy way access these icons and arbitrarily insert them into Markdown content. Us
This is a metapackage bringing in crystal extras requires for python3-mkdocstrings. It makes sure the dependencies are installed.
This is a metapackage bringing in python extras requires for python3-mkdocstrings. It makes sure the dependencies are installed.
This is a metapackage bringing in python-legacy extras requires for python3-mkdocstrings. It makes sure the dependencies are installed.
mkdocstrings Automatic documentation from sources, for MkDocs. Come have a chat or ask questions on our Gitter channel. Features - Installation - Quick usage Features Language-agnostic: just like MkDocs, mkdocstrings is written in Python but is language-agnostic. It means you can use it with any programming language, as long as there is a handler for it. We currently have handlers for the Crystal, Python, and VBA languages, as well as for shell scripts/libraries. Maybe you'd like to add another one to the list? :wink: Multiple themes support: each handler can offer multiple themes. Currently, we offer the :star: Material theme :star: as well as basic support for the ReadTheDocs and MkDocs themes for the Python handler. Cross-references across pages: mkdocstrings makes it possible to reference headings in other Markdown files with the classic Markdown linking syntax: [identifier][] or [title][identifier] -- and you don't need to remember which exact page this object was on.