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

github.com/gkmngrgn/hugo-alageek-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGökmen Görgen <gkmngrgn@gmail.com>2021-06-13 01:36:20 +0300
committerGökmen Görgen <gkmngrgn@gmail.com>2021-06-13 01:36:20 +0300
commitfa59522f29b905c6655a2810494490ff58988fa4 (patch)
treea7d962f20c1d432ae91c17cd8db5beb641a9886e
parent2e23fcc30bb2c6933eee0db874153c1e6149c7f9 (diff)
update documentation.
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3bb26ad..cb6e7b2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# hugo-alageek-theme
+
A [Cocoa Enhaced](https://github.com/mtn/cocoa-eh-hugo-theme) based theme. It's rewritten with **Bootstrap 5**.
![](/images/screenshot.png)
@@ -8,6 +9,14 @@ Websites that are using hugo with alaGeek theme:
* https://alageek.com
* https://gokmengorgen.net
+
+## Bootstrap v5 Migration
+
+If you have Bootstrap v4 specific customizations on your theme, please
+take a look at [this documentation](https://getbootstrap.com/docs/5.0/migration/)
+or keep your theme in the old version.
+
+
## Features
* Social media links on the footer:
@@ -32,6 +41,7 @@ Websites that are using hugo with alaGeek theme:
* Pagination support in blog posts
* General and post-specific Table of Contents support.
+
## Supported Languages
* Catalan
@@ -41,6 +51,7 @@ Websites that are using hugo with alaGeek theme:
* Spanish
* Turkish
+
## Dependency versions
* bootstrap: 5.0.1
@@ -48,12 +59,14 @@ Websites that are using hugo with alaGeek theme:
* mathjax: ^3.0.0
* progressively: 1.2.5
+
## Typography
* Title: Merriweather Sans
* Content: Merriweather
* Code: Fira Code
+
## Updates
### Goldmark Compatibility
@@ -65,6 +78,7 @@ files. Please take a look at [this
documentation](https://gohugo.io/getting-started/configuration-markup/) for more
information.
+
## License
Licensed under the MIT License. See the LICENSE.md file for more details.