diff options
Diffstat (limited to 'hugoBasicExample/README.md')
| -rw-r--r-- | hugoBasicExample/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/hugoBasicExample/README.md b/hugoBasicExample/README.md new file mode 100644 index 0000000..aa38bb6 --- /dev/null +++ b/hugoBasicExample/README.md @@ -0,0 +1,22 @@ +# hugoBasicExample + +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/). + +# Using + +1. [Install Hugo](https://gohugo.io/overview/installing/) +2. Clone this repository +```bash +git clone https://github.com/gohugoio/hugoBasicExample.git +cd hugoBasicExample +``` +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 |