-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
680d897
commit 992a672
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,32 @@ | ||
# obsidian-workflow-template-docs | ||
|
||
This is the documentation for my [obsidian-workflow-template](https://github.com/mathisgauthey/obsidian-workflow-template) project. | ||
|
||
## Technology used | ||
|
||
I'm using [MkDocs](https://www.mkdocs.org/) with the [Material theme](https://squidfunk.github.io/mkdocs-material/). | ||
|
||
It has a wonderful documentation and is very customizable. | ||
|
||
## Requirements | ||
|
||
```bash | ||
pip install mkdocs | ||
pip install mkdocs-material | ||
``` | ||
|
||
Don't forget the `sudo` before on linux, otherwise you might run into possible errors related to `command not found`. | ||
|
||
## Usage | ||
|
||
MkDocs includes a live preview server, so you can preview your changes as you write your documentation. The server will automatically rebuild the site upon saving. Start it with: | ||
|
||
```bash | ||
mkdocs serve | ||
``` | ||
|
||
When you're finished editing, you can build a static site from your Markdown files with: | ||
|
||
```bash | ||
mkdocs build | ||
``` |