From ba9c2abbe22b21696bf0dec05f87c4f34199d853 Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Mon, 1 Jul 2019 18:30:28 -0700 Subject: [PATCH] added document structure, site output to gitignore --- .gitignore | 1 + docs/index.md | 5 +++-- mkdocs.yml | 21 ++++++++++++++++----- 3 files changed, 20 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index a095526..0d7fe64 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ Eagle_Files/**/*.B\#* Eagle_Files/**/*.s\#* docs/**/*.odt\#* +site/* diff --git a/docs/index.md b/docs/index.md index 484bf71..9ab2295 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 \ No newline at end of file +The latest firmware for this project can be found [HERE](https://github.com/pyr0ball/pyr0piezo/tree/master/firmware/Compiled-Firmware) diff --git a/mkdocs.yml b/mkdocs.yml index f5876b2..96557bd 100644 --- a/mkdocs.yml +++ b/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'] - \ No newline at end of file +