mirror of
https://github.com/thomiceli/opengist.git
synced 2024-12-23 13:02:39 +00:00
6d31ef9732
* Add vitepress for docs * some fix * Use vitepress and update docs * Use vitepress and update docs * Update README.md * Add favicon * Add docs by @jiriks74 Co-authored-by: jiriks74 <jiri@stefka.eu> --------- Co-authored-by: jiriks74 <jiri@stefka.eu>
62 lines
1.8 KiB
Markdown
62 lines
1.8 KiB
Markdown
# Custom links
|
|
|
|
On the footer of your Opengist instance, you can add links to custom static templates or any other website you want to link to.
|
|
This can be useful for legal information, privacy policy, or any other information you want to provide to your users.
|
|
|
|
To add one or more links, you can add your own file to the `$opengist-home/custom` directory or set a URL, then define the relative path and its name in the config.
|
|
|
|
For example, if you have a legal information file `legal.html` in the `$opengist-home/custom` directory, and also wish to add a link to a Gitea instance, you can set the link in the config as follows:
|
|
|
|
#### YAML
|
|
```yaml
|
|
custom.static-links:
|
|
- name: Legal notices
|
|
path: legal.html
|
|
- name: Gitea
|
|
path: https://gitea.com
|
|
```
|
|
|
|
#### Environment variable
|
|
```sh
|
|
OG_CUSTOM_STATIC_LINK_0_NAME="Legal Notices" \
|
|
OG_CUSTOM_STATIC_LINK_0_PATH=legal.html \
|
|
OG_CUSTOM_STATIC_LINK_1_NAME=Gitea \
|
|
OG_CUSTOM_STATIC_LINK_1_PATH=https://gitea.com \
|
|
./opengist
|
|
```
|
|
|
|
## Templating custom HTML pages
|
|
|
|
In the start and end of the custom HTML files, you can use the syntax to include the header and footer of the Opengist instance:
|
|
|
|
```html
|
|
{{ template "header" . }}
|
|
|
|
<!-- my content -->
|
|
|
|
{{ template "footer" . }}
|
|
```
|
|
|
|
If you want your custom page to integrate well into the existing theme, you can use the following:
|
|
|
|
```html
|
|
{{ template "header" . }}
|
|
|
|
<div class="py-10">
|
|
<header class="pb-4 ">
|
|
<div class="flex">
|
|
<div class="flex-auto">
|
|
<h2 class="text-2xl font-bold leading-tight">Heading</h2>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<main>
|
|
<h3 class="text-xl font-bold leading-tight mt-4">Sub-Heading</h3>
|
|
<p class="mt-4 ml-1"><!-- my content --></p>
|
|
</main>
|
|
</div>
|
|
|
|
{{ template "footer" . }}
|
|
```
|
|
|
|
You can adjust above as needed. Opengist uses TailwindCSS classes.
|