OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity
ce9ca56142
mkdocs-material/docs/index.md
squidfunk ce9ca56142 Update README and index page
2017-01-12 00:49:28 +01:00

2.0 KiB
Raw Blame History

Material for MkDocs

Build beautiful documentation

Material is a theme for MkDocs, an excellent static site generator geared towards project documentation. It is built using Google's Material Design guidelines, fully responsive and optimized for touch and pointer devices.

Material is very lightweight – it is built from scratch using Javascript and CSS that weighs approximately 30kb (minified, gzipped and excluding Google Fonts and Analytics). Yet, it is highly customizable and degrades gracefully in older browsers.

Quick start

Install the latest version of Material with pip:

pip install mkdocs-material

Add the following line to your mkdocs.yml:

theme: 'material'

For detailed instructions see the getting started guide.

Features

  • Beautiful, readable and very user-friendly design based on Google's Material Design guidelines, packed in a full responsive template with a well-defined and easily customizable color palette, great typography, as well as a beautiful search interface.

  • Responsive specimen like code blocks, tables that work on all screen sizes, working with and without JavaScript which makes it gracefully degrade in older browsers.

  • Extra configuration options like a project logo, links to social accounts, display of the amount of stars your project has on GitHub and Google Analytics integration.

  • Easily extendable and customizable due to a well-designed asset pipeline built on-top of modern web technologies and modular and abstracted style definitions..

  • Web application capability on iOS – when the page is saved to the homescreen, it behaves and looks like a native application.