diff --git a/_includes/carousel_img.html b/_includes/carousel_img.html index 669da45..45d5680 100644 --- a/_includes/carousel_img.html +++ b/_includes/carousel_img.html @@ -11,5 +11,5 @@ {% endif %}
- {{ alt }} + {{ alt }}
\ No newline at end of file diff --git a/_includes/index_carousel.html b/_includes/index_carousel.html index 449d0dd..e2f5529 100644 --- a/_includes/index_carousel.html +++ b/_includes/index_carousel.html @@ -2,47 +2,47 @@ {% include "carousel_start.html" %} {% endwith %} -{% with src="index/part_category.png", alt="Part Categories", active=True %} +{% with src="index/part_category.png", min_height="400px", max_height="400px", alt="Part Categories", active=True %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/part_stock.png", alt="Part Stock" %} +{% with src="index/part_stock.png", min_height="400px", max_height="400px", alt="Part Stock" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/part_suppliers.png", alt="Part Suppliers" %} +{% with src="index/part_suppliers.png", min_height="400px", max_height="400px", alt="Part Suppliers" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/stock_item.png", alt="Stock Item" %} +{% with src="index/stock_item.png", min_height="400px", max_height="400px", alt="Stock Item" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/stock_location.png", alt="Stock Location" %} +{% with src="index/stock_location.png", min_height="400px", max_height="400px", alt="Stock Location" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/stock_location_2.png", alt="Stock Location" %} +{% with src="index/stock_location_2.png", min_height="400px", max_height="400px", alt="Stock Location" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/suppliers.png", alt="Suppliers" %} +{% with src="index/suppliers.png", min_height="400px", max_height="400px", alt="Suppliers" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/part_admin.png", alt="Admin Interface" %} +{% with src="index/part_admin.png", min_height="400px", max_height="400px", alt="Admin Interface" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/category_params.png", alt="Part Parameters" %} +{% with src="index/category_params.png", min_height="400px", max_height="400px", alt="Part Parameters" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/build_outputs.png", alt="Build Orders" %} +{% with src="index/build_outputs.png", min_height="400px", max_height="400px", alt="Build Orders" %} {% include "carousel_img.html" %} {% endwith %} -{% with src="index/bom_add_item.png", alt="Bill of Materials" %} +{% with src="index/bom_add_item.png", min_height="400px", max_height="400px", alt="Bill of Materials" %} {% include "carousel_img.html" %} {% endwith %} diff --git a/_includes/overrides/home.html b/_includes/overrides/home.html new file mode 100644 index 0000000..a04eaf5 --- /dev/null +++ b/_includes/overrides/home.html @@ -0,0 +1,45 @@ +{% extends "base.html" %} + +{% block tabs %} +{{ super() }} + +{% endblock %} + +{% block content %} + +{{ page.content }} + + + + +
+
+
+ + +
+ + Features + + + Install + + + Source Code + + + Get the App + + + Translate + +
+
+
+
+ +{% endblock %} diff --git a/docs/app/app.md b/docs/app/app.md index 501a01c..72a200e 100644 --- a/docs/app/app.md +++ b/docs/app/app.md @@ -2,7 +2,9 @@ title: InvenTree Mobile App --- -## InvenTree Mobile App +{% include "app_carousel.html" %} + +----- The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../extend/api.md), the app provides immediate access to inventory data without requiring physical access to a computer. @@ -18,5 +20,3 @@ The InvenTree App can be downloaded for Android devices via the [Play Store](htt !!! missing "Not Yet Available" The InvenTree app is not yet available for iOS devices - -{% include "app_carousel.html" %} diff --git a/docs/assets/images/paper_splash.jpg b/docs/assets/images/paper_splash.jpg new file mode 100644 index 0000000..e466708 Binary files /dev/null and b/docs/assets/images/paper_splash.jpg differ diff --git a/docs/features.md b/docs/features.md index 55e946b..395ab7f 100644 --- a/docs/features.md +++ b/docs/features.md @@ -2,6 +2,17 @@ title: Features --- +## InvenTree + +InvenTree is an open-source inventory management system which provides intuitive parts management and stock control. + + +It is designed to be lightweight and easy to use for SME or hobbyist applications, where many existing stock management solutions are bloated and cumbersome to use. However, powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information. InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight SQLite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users. + + +InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API. + + ## Organize Parts Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. diff --git a/docs/index.md b/docs/index.md index a4730f2..9b8fa10 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,38 +1,17 @@ --- title: InvenTree +template: home.html +hide: + - toc + - navigation --- -## InvenTree +## Intuitive inventory management -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![GitHub Repo stars](https://img.shields.io/github/stars/inventree/inventree?label=View%20On%20GitHub&style=social)](https://github.com/inventree/inventree) -[![Docker Pulls](https://img.shields.io/docker/pulls/inventree/inventree)](https://hub.docker.com/r/inventree/inventree) +### *An open source inventory management suite that simply works* - -InvenTree is an open-source inventory management system which provides intuitive parts management and stock control. - -InvenTree is designed to be lightweight and easy to use for SME or hobbyist applications, where many existing stock management solutions are bloated and cumbersome to use. However, powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information. +-------------- {% include "index_carousel.html" %} -### How it Works - -InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API. - -InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight SQLite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users. - -## Features - -Refer to the [features](./features.md) page for a rundown on the features that InvenTree provides out of the box. - -## Getting Started - -Refer to the [installation guide](./start/intro.md) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed. - -## Get the App - -InvenTree is supported by a [companion mobile app](./app/app.md) which is tightly integrated with the InvenTree database. Lightning fast stock control, in your pocket! - -## Source Code - -InvenTree source code is available on [GitHub](https://github.com/inventree/inventree) +-------------- \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7f76d83..cfa7b91 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ theme: custom_dir: _includes/overrides palette: scheme: default + accent: light blue logo: assets/logo.png favicon: assets/favicon.ico icon: @@ -40,13 +41,12 @@ extra_javascript: # Navigation nav: - InvenTree: - - About InvenTree: index.md - Features: features.md - Release Notes: releases/release_notes.md - FAQ: faq.md - Contribute: contribute.md - Credits: credits.md - - Installation: + - Install: - Introduction: start/intro.md - Configuration: start/config.md - Docker Setup: start/docker.md