From 2e4bc7a97f3e24acbdbb7a3373b8f6517309ca44 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 5 Apr 2020 17:23:07 +0200 Subject: [PATCH] Refactored README.md --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 375bd45ab..43773c987 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@

- Material for MkDocs + + Material for MkDocs + +

+ +

+ + A + Material Design + theme for + MkDocs + +

@@ -46,12 +58,17 @@ ## Features -* **It's just Markdown** – you just write your technical documentation in - Markdown, so there's no need to know any HTML, JavaScript or CSS. Material for - MkDocs will do the heavy lifting and generate a beautiful and functional - website. +* **It's just Markdown** — write your technical documentation in plain Markdown – no need to know HTML, JavaScript or CSS. Material for MkDocs will do the heavy lifting and convert your writing to a beautiful and functional website. -* **Looks great on every device**: Material for MkDocs is built... +* **Responsive by design** — built from the ground up to work on all sorts of devices – from mobile phones to wide screens. The underlying fluid layout will always adapt perfectly to the available screen space. + +* **Static, yet searchable** — almost magically, your technical documentation website will be searchable without any further ado. Material for MkDocs comes with built-in search – no server needed – that will instantly answer your users' queries. + +* **Many configuration options** — change the color palette, font families, language, icons and favicon, logo. Add a source repository link, links to your social profiles, Google Analytics and Disqus - all with a few lines of code. + +* **Beyond GitHub Markdown** — integrates natively with Python Markdown Extensions, offering additional elements like callouts, tabbed content containers, mathematical formulas, critic markup, task lists and emojis. + +* **Modern architecture** — Material for MkDocs's underlying codebase is built with TypeScript, RxJS, and SCSS, and is compiled with Webpack. This brings great possibilities for theme extension and customization. ## Quick start