Skip to content

Commit 7f9f4f1

Browse files
committed
Update docs
1 parent 82676de commit 7f9f4f1

File tree

3 files changed

+27
-1
lines changed

3 files changed

+27
-1
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
site
2-
venv
2+
venv*
33
.vscode

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
11
# tp-docs
22

33
Wiki for [https://github.com/themepark-dev/theme.park/](https://github.com/themepark-dev/theme.park/)
4+
5+
### Docs Develop setup
6+
7+
```bash
8+
git clone https://github.com/themepark-dev/tp-docs.git
9+
python3 -m venv venv
10+
source venv/bin/activate
11+
pip install -r docs/requirements.txt
12+
mkdocs serve
13+
```

docs/setup/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
<li><a href="#develop">Develop</a></li>
2929
<li><a href="/community-themes/">Community Themes</a></li>
3030
<li><a href="/custom/#custom-github-setup">Custom Github Setup</a></li>
31+
<li><a href="#manually-download">Manual Download</a></li>
3132
</ul>
3233

3334
***
@@ -678,6 +679,8 @@ proxy /tautulli 127.0.0.1:8181 {
678679

679680
### Caddy v2
680681

682+
!!! warning
683+
This plugin will not work if the software uses websockets. See (https://github.com/sjtug/caddy2-filter/issues/10)
681684
>
682685
!!! info
683686
Thank you [jef](https://github.com/jef) for the write up!
@@ -929,3 +932,16 @@ sub_filter_once on;
929932
```
930933

931934
Docker mods: `-e TP_DOMAIN=develop.theme-park.dev`
935+
936+
937+
## Manually Download
938+
939+
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.
940+
941+
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.
942+
943+
944+
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)
945+
946+
!!! Tip
947+
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.

0 commit comments

Comments
 (0)