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

github.com/nodejh/hugo-theme-cactus-plus.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornodejh <jianghangscu@gmail.com>2021-03-02 05:53:54 +0300
committernodejh <jianghangscu@gmail.com>2021-03-02 05:53:54 +0300
commit34d3c2dd68e72bab166fcca1e470cdab0cff7761 (patch)
tree0fba6fc794e0be1cb5dafb41eac41f13af9d8f07
parentffea239839fd78d91b110f34344497e68eb1d024 (diff)
feat: update docs
-rw-r--r--README.md6
-rw-r--r--exampleSite/README.md31
-rw-r--r--exampleSite/config-example.yaml35
-rw-r--r--exampleSite/config.yaml10
4 files changed, 53 insertions, 29 deletions
diff --git a/README.md b/README.md
index 8a1fb4e..6324b92 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ Features:
1. From your project's root directory, initiate the hugo module system if you haven't already:
- ```
+ ```bash
$ hugo mod init github.com/<your_user>/<your_project>
```
@@ -45,7 +45,7 @@ Features:
1. Inside the folder of your Hugo site run:
- ```
+ ```bash
$ git submodule add https://github.com/nodejh/hugo-theme-mini.git themes/mini
```
@@ -109,7 +109,7 @@ You can replace the log in the top of each page and favicon with your own images
In order to see your site in action, run Hugo's built-in local server.
-```sh
+```bash
$ hugo server
```
diff --git a/exampleSite/README.md b/exampleSite/README.md
index 11a456c..7858fce 100644
--- a/exampleSite/README.md
+++ b/exampleSite/README.md
@@ -1,29 +1,18 @@
-# hugoBasicExample
+# Hugo Theme Mini Example Site
-This repository offers an example site for [Hugo](https://gohugo.io/) and also it provides the default content for demos hosted on the [Hugo Themes Showcase](https://themes.gohugo.io/).
+This repository offers an example site for [Hugo Theme mini](https://github.com/nodejh/hugo-theme-mini) and also it provides the default content for [Online Demo](http://nodejh.github.io/hugo-theme-mini).
# Using
1. [Install Hugo](https://gohugo.io/overview/installing/)
2. Clone this repository
-```bash
-git clone https://github.com/gohugoio/hugoBasicExample.git
-cd hugoBasicExample
-```
+ ```bash
+ $ git clone https://github.com/nodejh/hugo-theme-mini
+ $ cd exampleSite
+ ```
+3. Run Hugo server. The exampleSite use theme `hugo-theme-mini` by setting `themesDir` as `../../`
-3. Clone the repository you want to test. If you want to test all Hugo Themes then follow the instructions provided [here](https://github.com/gohugoio/hugoThemes#installing-all-themes)
-
-4. Run Hugo and select the theme of your choosing
-
-```bash
-hugo server -t YOURTHEME
-```
-
-5. Under `/content/` this repository contains the following:
-
-- A section called `/post/` with sample markdown content
-- A headless bundle called `homepage` that you may want to use for single page applications. You can find instructions about headless bundles over [here](https://gohugo.io/content-management/page-bundles/#headless-bundle)
-- An `about.md` that is intended to provide the `/about/` page for a theme demo
-
-6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) respository
+ ```bash
+ $ hugo server
+ ```
diff --git a/exampleSite/config-example.yaml b/exampleSite/config-example.yaml
new file mode 100644
index 0000000..be89d96
--- /dev/null
+++ b/exampleSite/config-example.yaml
@@ -0,0 +1,35 @@
+baseURL: https://nodejh.github.io/hugo-theme-mini
+languageCode: en-us
+title: Hugo
+theme: hugo-theme-mini
+
+# for exampleSite only, you may need to delete the line: `themesDir: ../../`
+themesDir: ../../
+
+hasCJKLanguage: true
+permalinks:
+ posts: /posts/:title/
+
+googleAnalytics: nodejh
+disqusShortname: nodejh
+
+
+markup:
+ highlight:
+ guessSyntax: true
+ style: emacs
+
+
+social:
+ github: https://github.com/nodejh
+ twitter: your-github-link
+ stackoverflow: https://stackoverflow.com/users/4518882/nodejh
+
+
+params:
+ author: nodejh
+ bio: Software Engineer
+ description: My Blog
+ enableRSS: true
+ enableComments: true
+ enableGoogleAnalytics: true \ No newline at end of file
diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml
index 34832a7..76f1c1d 100644
--- a/exampleSite/config.yaml
+++ b/exampleSite/config.yaml
@@ -24,10 +24,10 @@ markup:
# Social links in footer, support github,twitter,stackoverflow,facebook
social:
# e.g.
- github: 'your-github-link'
- twitter: 'your-github-link'
- stackoverflow: 'your-github-link'
- # facebook: 'your-facebook-link'
+ github: your-github-link
+ twitter: your-github-link
+ stackoverflow: your-github-link
+ # facebook: your-facebook-link
# Site parameters
@@ -38,7 +38,7 @@ params:
bio: Software Engineer
# Site Description, used in HTML meat
description: My Blog
- enableRSS: false
+ enableRSS: true
# To enable comments, you may need to set `disqusShortname`
enableComments: true
# To enable comments, you may need to set `googleAnalytics`