added document structure, site output to gitignore
This commit is contained in:
parent
69c9405e0f
commit
ba9c2abbe2
3 changed files with 20 additions and 7 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,3 +1,4 @@
|
|||
Eagle_Files/**/*.B\#*
|
||||
Eagle_Files/**/*.s\#*
|
||||
docs/**/*.odt\#*
|
||||
site/*
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
# Documentation for Pyr0-Piezo
|
||||
## Documentation for Pyr0-Piezo Z-Probe Sensors
|
||||
|
||||
Pyr0-Piezo is a circuit design that incorporates the use of Piezoelectric Elements in order to reliably sense the real-world location of a 3D printer's bed. It incorporates a microcontroller (MCU) to sense the specific conditions of a printer that could effect the sensor's input, and make on-the-fly adjustments to ensure a consistent reading.
|
||||
|
||||
## Under Construction
|
||||
The latest firmware for this project can be found [HERE](https://github.com/pyr0ball/pyr0piezo/tree/master/firmware/Compiled-Firmware)
|
||||
|
|
|
|||
19
mkdocs.yml
19
mkdocs.yml
|
|
@ -1,9 +1,20 @@
|
|||
site_name: Pyr0-Piezo
|
||||
site_description: Documentation for the Pyr0-Piezo Z-probe sensor
|
||||
site_author: Alan "pyr0ball" Weinstock
|
||||
repo_url: https://github.com/pyr0ball/pyr0piezo/
|
||||
|
||||
markdown_extensions:
|
||||
#http://pythonhosted.org/Markdown/extensions/admonition.html
|
||||
- admonition:
|
||||
- toc:
|
||||
permalink: True
|
||||
|
||||
nav:
|
||||
- 'Home': 'docs/index.md'
|
||||
- 'About': 'docs/about.md'
|
||||
- 'FAQ': 'docs/faq.md'
|
||||
- 'Configuration': 'docs/config.md'
|
||||
- 'Home': 'index.md'
|
||||
- 'About': 'about.md'
|
||||
- 'FAQ': 'faq.md'
|
||||
- 'Configuration': 'config.md'
|
||||
- 'Main Site': 'https://pyroballpcbs.com'
|
||||
|
||||
google_analytics: ['UA-135668867-1', 'pyroballpcbs.com']
|
||||
|
||||
Loading…
Reference in a new issue