diff --git a/.gitignore b/.gitignore index 9631761c..c52ef795 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ site -venv +venv* .vscode \ No newline at end of file diff --git a/README.md b/README.md index 2d2b60f9..9ec1fe2e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # tp-docs Wiki for [https://github.com/themepark-dev/theme.park/](https://github.com/themepark-dev/theme.park/) + +### Docs Develop setup + +```bash +git clone https://github.com/themepark-dev/tp-docs.git +python3 -m venv venv +source venv/bin/activate +pip install -r docs/requirements.txt +mkdocs serve +``` diff --git a/docs/setup/index.md b/docs/setup/index.md index e072c6bf..11819509 100644 --- a/docs/setup/index.md +++ b/docs/setup/index.md @@ -28,6 +28,7 @@
  • Develop
  • Community Themes
  • Custom Github Setup
  • +
  • Manual Download
  • *** @@ -678,6 +679,8 @@ proxy /tautulli 127.0.0.1:8181 { ### Caddy v2 +!!! warning + This plugin will not work if the software uses websockets. See (https://github.com/sjtug/caddy2-filter/issues/10) > !!! info Thank you [jef](https://github.com/jef) for the write up! @@ -929,3 +932,16 @@ sub_filter_once on; ``` Docker mods: `-e TP_DOMAIN=develop.theme-park.dev` + + +## Manually Download + +If you want to manually download the css files used in this project, you can find all css files in the [`/css`](https://github.com/themepark-dev/theme.park/tree/master/css) folder on github. + +The base files can be found in the [`/base`](https://github.com/themepark-dev/theme.park/tree/master/css/base) folder, and the theme option files (that contains the css to actually give it some color) can be found in the [`/theme-options`](https://github.com/themepark-dev/theme.park/tree/master/css/theme-options) folder. + + +The [`/defaults`](https://github.com/themepark-dev/theme.park/tree/master/css/defaults) contains a couple of extra files that you will also need depending on the base css file you are downloading. (See the imports in each base file) + +!!! Tip + I reccomend to switch to the [`live`](https://github.com/themepark-dev/theme.park/tree/live/css) or [`develop`](https://github.com/themepark-dev/theme.park/tree/develop/css) branch on github when downloading the base files as those base files have the contents of the the imports directly in them, so you don't need the `placeholders.css` or `transparent.css` css files etc. \ No newline at end of file