docs: readme with config template
This commit is contained in:
parent
35c4ca5eb4
commit
8d47065573
47
README.md
47
README.md
@ -1,7 +1,46 @@
|
|||||||
# Theme Name
|
<div align="center" style="padding: 20px;">
|
||||||
|
<img src="./docs/media/thunderball.jpeg" alt="Thunderball" width="80%" style="padding-bottom: 15px">
|
||||||
|
<h1 style="padding-top: 15px">Thunderball</h1>
|
||||||
|
</div>
|
||||||
|
|
||||||
## Features
|
### Configuration
|
||||||
|
|
||||||
## Installation
|
```yaml
|
||||||
|
baseURL: https://example.com/
|
||||||
|
title: Example
|
||||||
|
language: en-GB
|
||||||
|
|
||||||
## Configuration
|
params:
|
||||||
|
contacts:
|
||||||
|
- name: email
|
||||||
|
url: mailto:hello@example.org
|
||||||
|
display: hello@example.org
|
||||||
|
- name: matrix
|
||||||
|
url: https://matrix.to/#/@hello:example.org
|
||||||
|
display: "@hello:example.org"
|
||||||
|
# ...
|
||||||
|
|
||||||
|
others:
|
||||||
|
- name: .onion
|
||||||
|
url: http://exampledkoip1xka89xmlawooedj.onion
|
||||||
|
display: example...awooedj.onion
|
||||||
|
# ...
|
||||||
|
|
||||||
|
services:
|
||||||
|
- name: blog
|
||||||
|
url: /blog
|
||||||
|
# ...
|
||||||
|
|
||||||
|
assets:
|
||||||
|
favicon: favicon.ico
|
||||||
|
favicon16: favicon-16x16.png
|
||||||
|
favicon32: favicon-32x32.png
|
||||||
|
appleTouchIcon: apple-touch-icon.png
|
||||||
|
safariPinnedTabIcon: safari-pinned-tab.svg
|
||||||
|
safariPinnedTabColor: "#0a0a0a"
|
||||||
|
manifest: manifest.json
|
||||||
|
msTileColor: "#0a0a0a"
|
||||||
|
msTileIcon: mstile-150x150.png
|
||||||
|
themeColor: "#0a0a0a"
|
||||||
|
logo: logo.svg
|
||||||
|
```
|
||||||
|
BIN
docs/media/thunderball.jpeg
Normal file
BIN
docs/media/thunderball.jpeg
Normal file
Binary file not shown.
After Width: | Height: | Size: 257 KiB |
Loading…
x
Reference in New Issue
Block a user