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
0eb02a0d10
mkdocs-material/docs/index.md
squidfunk 9d9effc106 Updated documentation
2016-02-17 18:08:11 +01:00

2.1 KiB
Raw Blame History

Material for MkDocs

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, full responsive, optimized for touch and pointer devices as well as all sorts of screen sizes.

Material Screenshot

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

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 color palette, great typography, as well as a beautiful search interface and footer.

  • Well-tested and optimized Javascript and CSS including a cross-browser fixed/sticky header, a drawer that even works without Javascript using the checkbox hack with fallbacks, responsive tables that scroll when the screen is too small and well-defined print styles.

  • Extra configuration options like a project logo, links to the authors GitHub and Twitter accounts and display of the amount of stars the project has on GitHub.

  • Easily extendable and customizable due to a well-designed asset pipeline built on-top of Gulp with npm and bower and modular and abstracted style definitions built with SASS.

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

See the getting started guide for instructions how to get it up and running.