inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-15 03:35:35 +00:00
Code Activity

Added documentation about Color Themes, added README mardown instructions

Browse Source
This commit is contained in:
eeintech
2020-09-21 12:27:10 -05:00
parent 863311bcce
commit 01f82a0128
5 changed files with 79 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,6 +1,6 @@
# InvenTree Documentation
This repository hosts the official documentation for [InvenTree](https://github.com/inventree/inventree), an open source inventory management system.
This repository hosts the [official documentation](https://inventree.readthedocs.io/) for [InvenTree](https://github.com/inventree/inventree), an open source inventory management system.
To serve this documentation locally (e.g. for development), you will need to have Python 3 installed on your system.
@ -18,7 +18,7 @@ $ pip install -r requirements.txt
## Serve Locally
To serve the pages locally, run the command (from the top-level project directory)
To serve the pages locally, run the following command (from the top-level project directory):
```
$ mkdocs serve
@ -28,6 +28,37 @@ $ mkdocs serve
Once the server is running, it will monitor the documentation files for any changes, and update the served pages.
### Admonitions
"Admonition" blocks can be added as follow:
```
!!! info "This is the admonition block title"
This is the admonition block content
```
Refer to the [reference documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) to customize the admonition block to the use-case (eg. warning, missing, info, etc.).
### Images
Images are served from the `./docs/assets/images` folder and can be added as follow:
```
{% with id="image_id", url="folder/image_name.png", description="Text shown if image is not loaded properly" %}
{% include 'img.html' %}
{% endwith %}
```
Replace:
* `image_id` with a short unique indentifier for the image (most commonly, `image_id` is same as `image_name`)
* `folder` with the folder in `docs/assets/images` in which the image is stored
* `image_name` with the name of the image
* `.png` with the image extension (PNG or JPEG are preferred formats)
### Global variables
Refer to the [reference documentation](https://squidfunk.github.io/mkdocs-material/reference/variables/#using-custom-variables) to find out how to add global variables to the documentation site.
Global variables should be added in the `# Global Variables` section of the `mkdocs.yml` configuration file.
## Credits
This documentation makes use of the [mkdocs-material template](https://github.com/squidfunk/mkdocs-material)