added document structure, site output to gitignore

This commit is contained in:
pyr0ball 2019-07-01 18:30:28 -07:00
parent 69c9405e0f
commit ba9c2abbe2
3 changed files with 20 additions and 7 deletions

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
Eagle_Files/**/*.B\#* Eagle_Files/**/*.B\#*
Eagle_Files/**/*.s\#* Eagle_Files/**/*.s\#*
docs/**/*.odt\#* docs/**/*.odt\#*
site/*

View file

@ -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)

View file

@ -1,9 +1,20 @@
site_name: Pyr0-Piezo 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: nav:
- 'Home': 'docs/index.md' - 'Home': 'index.md'
- 'About': 'docs/about.md' - 'About': 'about.md'
- 'FAQ': 'docs/faq.md' - 'FAQ': 'faq.md'
- 'Configuration': 'docs/config.md' - 'Configuration': 'config.md'
- 'Main Site': 'https://pyroballpcbs.com'
google_analytics: ['UA-135668867-1', 'pyroballpcbs.com'] google_analytics: ['UA-135668867-1', 'pyroballpcbs.com']