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

github.com/qqhann/hugo-primer.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorqqhann <qiu.gits@gmail.com>2019-12-02 18:02:47 +0300
committerqqhann <qiu.gits@gmail.com>2019-12-02 18:02:47 +0300
commit04a01a56b7082094e1339b8d6be2a9b1797fb004 (patch)
treeeb749d94570522e1ee3edf9ffe21f51b6fc67d48
parent62a613de35e98e8263204ac8beea71ff37e7e20a (diff)
Update: format
-rw-r--r--README.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index dfc2ee6..4856bad 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@ Try it now, and leave me a star if you like it!
![screenshot](https://github.com/qqhann/hugo-primer/blob/master/images/screenshot.png)
## Features
+
- [x] Primer css like theme
- [x] Menu bar header
- [x] Colored code pen
@@ -19,17 +20,21 @@ Try it now, and leave me a star if you like it!
- [x] Social Share buttons
## Installation
+
Clone to your theme directory:
+
```terminal
-$ git clone https://github.com/qqhann/hugo-primer.git themes/hugo-primer
+git clone https://github.com/qqhann/hugo-primer.git themes/hugo-primer
-$ hugo server --theme=hugo-primer
+hugo server --theme=hugo-primer
```
## Usage
#### config.toml
+
You can configure Hugo-Primer behavior with these params in your blog's `config.toml`. Shown are defaults and most recommended configs.
+
```config.toml
# config.toml
@@ -50,6 +55,7 @@ showFooterCredits = true
```
That being said, below is all recommended configuration example.
+
```config.toml
# config.toml
@@ -87,7 +93,9 @@ showFooterCredits = true
```
#### archetypes/default.md
+
It is also recommended to remove your site's `archetypes/default.md`, or copy Hugo-Primer's `archetypes/default.md` to your site.
+
```archetypes/default.md
---
title: "{{ replace .Name "-" " " | title }}"
@@ -100,7 +108,8 @@ keywords:
```
Example usage:
-```
+
+```md
---
categories:
- Diary
@@ -109,6 +118,7 @@ tags:
- Health
---
```
+
Set keywords for seo.
#### ruby annotation
@@ -119,14 +129,16 @@ Set keywords for seo.
You just need one line shortcodes code:
-```
+```html
{{< ruby rb="深表遗憾" rt="Xi Wen Le Jian" >}}
{{< ruby rb="My heart is broken." rt="I'm happy for that." >}}
```
## Contributing
+
Issues and PRs are welcome. :)
## License
+
MIT