Skip to content

Commit

Permalink
use requirements.txt for providing necessary dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
mikerooni committed Sep 10, 2023
1 parent 70ef629 commit ae9b4a7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ This documentation project is built using [MkDocs](https://www.mkdocs.org/#).
For an autmatically updating live preview in your browser, run `mkdocs serve`


## Installing MkDocs & MkDocs-Material
## Installing Required Dependencies

To install the required dependencies, please refer to the following pages:
- https://squidfunk.github.io/mkdocs-material/getting-started/#with-pip
- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
To install the required dependencies, please run `pip install -r requirements.txt`


## Used MkDocs Plugins

The following plugins for MkDocs are being used:

- https://squidfunk.github.io/mkdocs-material/
- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

## Contributing

Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
mkdocs
mkdocs-material
mkdocs-awesome-pages-plugin
pymdown-extensions

0 comments on commit ae9b4a7

Please sign in to comment.