Skip to content

Commit

Permalink
Some structure
Browse files Browse the repository at this point in the history
  • Loading branch information
reemo3dp committed Jan 1, 2024
1 parent 2ffdb76 commit 4965f3c
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 16 deletions.
Empty file.
Empty file.
17 changes: 1 addition & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,2 @@
# Welcome to MkDocs
# Home

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Empty file.
Empty file added docs/troubleshooting/index.md
Empty file.
1 change: 1 addition & 0 deletions includes/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*[lsusb]: A read-only utility on Linux that shows connected USB devices
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,24 @@ repo_url: https://github.com/reemo3dp/notes

theme:
name: material
features:
- content.tooltips
- navigation.tabs
palette:
scheme: slate
primary: purple
accent: indigo

markdown_extensions:
- abbr
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.superfences
- pymdownx.snippets:
auto_append:
- includes/glossary.md

watch:
- includes

0 comments on commit 4965f3c

Please sign in to comment.