diff options
| author | Damien <damlobster@gmail.com> | 2021-07-22 00:40:40 +0200 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2021-07-27 13:15:25 -0400 |
| commit | cff61605fb7260ab60d1abd4e295b71a533869ac (patch) | |
| tree | f117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/Overview.md | |
| parent | 7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff) | |
| download | kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip | |
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.
Signed-off-by: Damien Martin <damlobster@gmail.com>
Update CNAME
Diffstat (limited to 'docs/Overview.md')
| -rw-r--r-- | docs/Overview.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/Overview.md b/docs/Overview.md index 21daffe3..7d712433 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -1,8 +1,10 @@ +# Overview + Welcome to the Klipper documentation. If new to Klipper, start with the [features](Features.md) and [installation](Installation.md) documents. -# Overview information +## Overview information - [Features](Features.md): A high-level list of features in Klipper. - [FAQ](FAQ.md): Frequently asked questions. @@ -12,7 +14,7 @@ may require users to update their printer config file. - [Contact](Contact.md): Information on bug reporting and general communication with the Klipper developers. -# Configuration and Tuning Guides +## Configuration and Tuning Guides - [Installation](Installation.md): Guide to installing Klipper. - [Config Reference](Config_Reference.md): Description of config @@ -52,7 +54,7 @@ communication with the Klipper developers. tools such as lasers or spindles. - [G-Codes](G-Codes.md): Information on commands supported by Klipper. -# Developer Documentation +## Developer Documentation - [Code overview](Code_Overview.md): Developers should read this first. @@ -74,7 +76,7 @@ communication with the Klipper developers. improvements to Klipper. - [Packaging](Packaging.md): Information on building OS packages. -# Device Specific Documents +## Device Specific Documents - [Example configs](Example_Configs.md): Information on adding an example config file to Klipper. |