mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-06-15 03:35:35 +00:00
Initial commit
- Copied from inventree.github.io
This commit is contained in:
33
README.md
Normal file
33
README.md
Normal file
@ -0,0 +1,33 @@
|
||||
# InvenTree.github.io
|
||||
|
||||
This repository hosts the user documentation 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.
|
||||
|
||||
## Setup
|
||||
|
||||
Run the following commands from the top-level project directory:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/inventree/inventree-docs
|
||||
$ cd inventree-docs
|
||||
$ python3 -m venv env-inv-doc
|
||||
$ source env-inv-doc/bin/activate
|
||||
$ pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Serve Locally
|
||||
|
||||
To serve the pages locally, run the command (from the top-level project directory)
|
||||
|
||||
```
|
||||
$ mkdocs serve
|
||||
```
|
||||
|
||||
## Edit Documentation Files
|
||||
|
||||
Once the server is running, it will monitor the documentation files for any changes, and update the served pages.
|
||||
|
||||
## Credits
|
||||
|
||||
This documentation makes use of the [mkdocs-material template](https://github.com/squidfunk/mkdocs-material)
|
Reference in New Issue
Block a user