forked from nodejh/hugo-theme-mini
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
53 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters