Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/humrochagf/colordrop.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHumberto Rocha <humrochagf@gmail.com>2020-10-30 17:46:19 +0300
committerHumberto Rocha <humrochagf@gmail.com>2020-10-30 17:46:19 +0300
commitfd5abe2709279770f9937580aea795354c309978 (patch)
tree9aad36ced02ac8934d5ca174eea965b1b5bc6163
parente66eacea7889e3295a1601f3b44e667b6d700365 (diff)
Add toml description
-rw-r--r--README.md53
1 files changed, 49 insertions, 4 deletions
diff --git a/README.md b/README.md
index da89866..2ce3df8 100644
--- a/README.md
+++ b/README.md
@@ -16,12 +16,20 @@ Then add it as submodule of your repository:
git submodule add git@github.com:humrochagf/colordrop.git themes/colordrop
```
-And add this configuration to your blog config.yaml
+And add this configuration to your blog config.
+
+- yaml:
```yaml
theme: colordrop
```
+- toml:
+
+```toml
+theme = "colordrop"
+```
+
### Version pinning
You can pin a version of the theme by checking to a version tag:
@@ -43,15 +51,25 @@ You just need to download it at the version you want from the [release](https://
└── colordrop
```
-And add this configuration to your blog config.yaml
+And add this configuration to your blog config.
+
+- yaml:
```yaml
theme: colordrop
```
+- toml:
+
+```toml
+theme = "colordrop"
+```
+
## Customize Colors
-The theme colors can be customized by changing the `themeColor` and `themeInverseColor` variables at params:
+The theme colors can be customized by changing the `themeColor` and `themeInverseColor` variables at params.
+
+- yaml:
```yaml
params:
@@ -59,27 +77,54 @@ params:
themeInverseColor: "#ffffff"
```
+- toml:
+
+```toml
+[params]
+themeColor = "#000000"
+themeInverseColor = "#ffffff"
+```
+
![theme colors image](https://raw.githubusercontent.com/humrochagf/colordrop/master/images/tn.png)
## Home page and Logo
The website logo can be set with the variable `siteLogo` while the variable `description` will be the displayed at the website home page.
+- yaml:
+
```yaml
params:
description: Welcome to my blog...
siteLogo: "logo-photo.png"
```
+- toml:
+
+```toml
+[params]
+description = "Welcome to my blog..."
+siteLogo = "logo-photo.png"
+```
+
## Custom CSS
-You can load your custom CSS files by adding them under the `static` folder, e.g. `static/css/custom.css` and then defining the parameters as a list:
+You can load your custom CSS files by adding them under the `static` folder, e.g. `static/css/custom.css` and then defining the parameters as a list.
+
+- yaml:
```yaml
params:
custom_css: ["css/custom.css"]
```
+- toml:
+
+```toml
+[params]
+custom_css = ["css/custom.css"]
+```
+
## Website Example
You check [my blog](https://humberto.io) to see the theme fully running.