Docs for plugin

This commit is contained in:
Lost Paul 2023-09-09 16:43:46 +02:00
parent ce21b2ebc0
commit 7bf6cd7b13
6 changed files with 42 additions and 0 deletions

2
.gitignore vendored
View file

@ -20,3 +20,5 @@ data.json
# Exclude macOS Finder (System Explorer) View States
.DS_Store
venv

View file

@ -0,0 +1,6 @@
## test
```js
console.log("test")
test()
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 271 KiB

17
docs/docs/index.md Normal file
View file

@ -0,0 +1,17 @@
# Welcome to MkDocs
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.

0
docs/docs/test.md Normal file
View file

17
docs/mkdocs.yml Normal file
View file

@ -0,0 +1,17 @@
site_name: Obsidian folder notes
theme:
name: material
logo: assets/2023_Obsidian_logo.svg.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode