summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorV.H. Belvadi <hello@vhbelvadi.com>2019-05-14 07:27:03 +0530
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-05-15 09:53:49 +0200
commit3920d5ff745f20a387065df2375e3c1e8e48191c (patch)
tree0f02e5f95921f1c10b5f8c91eb98cce32f7c0274 /README.md
parent69758569de9a0274655aeb64d4d10d79c2ca114d (diff)
Updated changes to load custom fonts better and load Oxygen locally. No more variables.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 5 insertions, 10 deletions
diff --git a/README.md b/README.md
index 9dec008..dc5bf22 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
## Features
* Clean simple design
* Mobile friendly
-* Customizable
+* Customisable
* Designed to not interfere with other layouts
* Zero initial configuration
@@ -133,12 +133,6 @@ params:
# - In git information
# - In blog posts
BookDateFormat: "Jan 2, 2006"
-
- # (Optional, default true) Enable or disable use of Google Fonts
- # When not specified or set to "true" the theme font Oxygen will be loaded from Google Fonts
- # When disabled i.e. set to "false" default browser sans-serif fonts will be used
- # Set your own fonts in your root `assets/custom.scss` (see ‘extra customisation’ below)
- googleFonts: false
```
@@ -176,11 +170,12 @@ There are few empty partials you can override in `layouts/partials/`
| `layouts/partials/docs/inject/menu-after.html` | At the end of `<nav>` menu block |
-### Extra Customization
+### Extra Customisation
| File | Description |
| -- | -- |
| `static/favicon.png` | Override default favicon |
-| `assets/custom.scss` | Customize or override scss styles |
+| `assets/custom.scss` | Customise or override scss styles |
+| `assets/_fonts.scss` | Load custom font files (e.g. from files hosted locally in your `static` folder) |
## Contributing
@@ -192,7 +187,7 @@ Primary goals are:
- Keep minimal (or zero) default configuration
- Avoid interference with user-defined layouts
-Feel free to open issue if you missing some configuration or customization option.
+Feel free to open issue if you missing some configuration or customisation option.
## License