Restructure project: add base theme and all modules like example
This commit is contained in:
34
example/modules/README.md
Normal file
34
example/modules/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
<div align="center">
|
||||
<img src="https://github.com/JamsRepos/Jamfin/blob/main/assets/logo.png?raw=true" alt="Logo" width="125"/>
|
||||
|
||||
## 🧩 Modules
|
||||
|
||||
Here you can find our assortment of modules. These are included within the complete pack of the theme however can be used in conjunction with the base theme or any other theme of your choosing.
|
||||
|
||||
## 🔌 Installation
|
||||
|
||||
The general format to install a module is as followed, you will need to replace the `<name>` with the file name of the module you wish to install.
|
||||
|
||||
<div align="left">
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/JamsRepos/Jamfin@latest/theme/modules/<name>.css");
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
#### ❓Where do I install it?
|
||||
|
||||
Locate the `Custom CSS code` option under your General settings in the admin panel and simply paste one of the lines above within the box.
|
||||
|
||||
If you wish to just install this for yourself only, you can do so by going to your users Display settings and copy the following settings.
|
||||
|
||||
- [x] Disable server-provided custom CSS code
|
||||
|
||||
Then enter the theme into the `Custom CSS code` option and save your settings.
|
||||
|
||||
## 🖌️ Customisation
|
||||
|
||||
Each module has it's own individual customisation parameters. Please read the respective README by going into each modules folder.
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user