inventree/inventree-website
2
0
Fork 0
mirror of https://github.com/inventree/inventree-website.git synced 2025-04-27 21:16:45 +00:00
Code

Add general docs

Browse Source 
Closes https://github.com/matmair/inventree-website/issues/29
This commit is contained in:
Matthias Mair 2022-10-25 00:04:39 +02:00
parent 370c23d514
commit 6c0ea44b0e
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -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.