feat: update docs

master
nodejh 4 years ago
parent ffea239839
commit 34d3c2dd68

@ -30,7 +30,7 @@ Features:
1. From your project's root directory, initiate the hugo module system if you haven't already: 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> $ hugo mod init github.com/<your_user>/<your_project>
``` ```
@ -45,7 +45,7 @@ Features:
1. Inside the folder of your Hugo site run: 1. Inside the folder of your Hugo site run:
``` ```bash
$ git submodule add https://github.com/nodejh/hugo-theme-mini.git themes/mini $ 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. In order to see your site in action, run Hugo's built-in local server.
```sh ```bash
$ hugo server $ hugo server
``` ```

@ -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 # Using
1. [Install Hugo](https://gohugo.io/overview/installing/) 1. [Install Hugo](https://gohugo.io/overview/installing/)
2. Clone this repository 2. Clone this repository
```bash ```bash
git clone https://github.com/gohugoio/hugoBasicExample.git $ git clone https://github.com/nodejh/hugo-theme-mini
cd hugoBasicExample $ 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) ```bash
$ hugo server
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

@ -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

@ -24,10 +24,10 @@ markup:
# Social links in footer, support github,twitter,stackoverflow,facebook # Social links in footer, support github,twitter,stackoverflow,facebook
social: social:
# e.g. # e.g.
github: 'your-github-link' github: your-github-link
twitter: 'your-github-link' twitter: your-github-link
stackoverflow: 'your-github-link' stackoverflow: your-github-link
# facebook: 'your-facebook-link' # facebook: your-facebook-link
# Site parameters # Site parameters
@ -38,7 +38,7 @@ params:
bio: Software Engineer bio: Software Engineer
# Site Description, used in HTML meat # Site Description, used in HTML meat
description: My Blog description: My Blog
enableRSS: false enableRSS: true
# To enable comments, you may need to set `disqusShortname` # To enable comments, you may need to set `disqusShortname`
enableComments: true enableComments: true
# To enable comments, you may need to set `googleAnalytics` # To enable comments, you may need to set `googleAnalytics`

Loading…
Cancel
Save