From 6c0ea44b0e73538b3affd633048e8f1bd46eb597 Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 25 Oct 2022 00:04:39 +0200 Subject: [PATCH] Add general docs Closes https://github.com/matmair/inventree-website/issues/29 --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 39376253..d9079dcc 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,27 @@ This project contains the source for the new InvenTree website. It is built on Jekyll and GitHub pages for backend / hosting and tailtwindcss for frontend. -## File structure +## Architecture -State as of ###. -``` bash +The website consists of content, layouts and assets. Jekyll runs and builds out of these files static html files - that are then hosted on GitHub pages. Folders with an underscore prefixed are internal folders for Jekyll, folders without are rendered as subdirectories in the output. -``` +Content: +`_data` contains data that is references on pages +`_news` contains news entries +`_posts` contains blog entries +`_publishers` contains authors/publishers +`_repo` will contain plugin repo entries + +Layouts: +`_includes` contains partials that can be used in layouts +`_layouts` contains the page defintions + +Assets: +`assets` contains static assets for the pages + +The site configuration is saved in `config.yaml`, required gems in `Gemfile` and npm packages in `package.json`. + +The CSS stylesheet uses tailwindcss and is built with postcss on demand. NodeJs is needed for this. The main css file is located in `assets/index.css`. Rebuilds are handled by the workflows automatically. ## Common commands Install packages for ruby and nodejs.