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
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
# Installation
|
||||
|
||||
These instructions assume the software will run on a Raspberry Pi
|
||||
computer in conjunction with OctoPrint. It is recommended that a
|
||||
Raspberry Pi 2, 3, or 4 computer be used as the host machine (see the
|
||||
@@ -9,8 +11,7 @@ micro-controllers,
|
||||
[ARM based micro-controllers](Features.md#step-benchmarks), and
|
||||
[Beaglebone PRU](beaglebone.md) based printers.
|
||||
|
||||
Prepping an OS image
|
||||
====================
|
||||
## Prepping an OS image
|
||||
|
||||
Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the
|
||||
Raspberry Pi computer. Use OctoPi v0.17.0 or later - see the
|
||||
@@ -38,8 +39,7 @@ setup Klipper to run at system startup, and start the Klipper host
|
||||
software. It will require an internet connection and it may take a few
|
||||
minutes to complete.
|
||||
|
||||
Building and flashing the micro-controller
|
||||
==========================================
|
||||
## Building and flashing the micro-controller
|
||||
|
||||
To compile the micro-controller code, start by running these commands
|
||||
on the Raspberry Pi:
|
||||
@@ -92,8 +92,7 @@ When flashing for the first time, make sure that OctoPrint is not
|
||||
connected directly to the printer (from the OctoPrint web page, under
|
||||
the "Connection" section, click "Disconnect").
|
||||
|
||||
Configuring OctoPrint to use Klipper
|
||||
====================================
|
||||
## Configuring OctoPrint to use Klipper
|
||||
|
||||
The OctoPrint web server needs to be configured to communicate with
|
||||
the Klipper host software. Using a web browser, login to the OctoPrint
|
||||
@@ -121,8 +120,7 @@ terminal window will likely report there is an error opening the
|
||||
config file - that means OctoPrint is successfully communicating with
|
||||
Klipper. Proceed to the next section.
|
||||
|
||||
Configuring Klipper
|
||||
===================
|
||||
## Configuring Klipper
|
||||
|
||||
The Klipper configuration is stored in a text file on the Raspberry
|
||||
Pi. Take a look at the example config files in the
|
||||
@@ -182,8 +180,7 @@ After Klipper reports that the printer is ready go on to the
|
||||
[config check document](Config_checks.md) to perform some basic checks
|
||||
on the pin definitions in the config file.
|
||||
|
||||
Contacting the developers
|
||||
=========================
|
||||
## Contacting the developers
|
||||
|
||||
Be sure to see the [FAQ](FAQ.md) for answers to some common questions.
|
||||
See the [contact page](Contact.md) to report a bug or to contact the
|
||||
|
||||
Reference in New Issue
Block a user