mirror of
https://github.com/lostpaul/obsidian-folder-notes.git
synced 2026-07-22 07:40:24 +00:00
Docs for plugin
This commit is contained in:
parent
ce21b2ebc0
commit
7bf6cd7b13
6 changed files with 42 additions and 0 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -20,3 +20,5 @@ data.json
|
|||
|
||||
# Exclude macOS Finder (System Explorer) View States
|
||||
.DS_Store
|
||||
|
||||
venv
|
||||
6
docs/docs/Folder overview/index.md
Normal file
6
docs/docs/Folder overview/index.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
## test
|
||||
|
||||
```js
|
||||
console.log("test")
|
||||
test()
|
||||
```
|
||||
BIN
docs/docs/assets/2023_Obsidian_logo.svg.png
Normal file
BIN
docs/docs/assets/2023_Obsidian_logo.svg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 271 KiB |
17
docs/docs/index.md
Normal file
17
docs/docs/index.md
Normal 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
0
docs/docs/test.md
Normal file
17
docs/mkdocs.yml
Normal file
17
docs/mkdocs.yml
Normal 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
|
||||
|
||||
|
||||
Loading…
Reference in a new issue