mirror of
				https://github.com/Wonderfall/hugo-WonderMod.git
				synced 2025-10-31 11:45:26 +01:00 
			
		
		
		
	Update README.md (#55)
This closes #38 This re-write aims to provide some instructions for this repo to theme authors and other users.
This commit is contained in:
		
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,8 +1,6 @@ | |||||||
| # hugoBasicExample | # hugoBasicExample | ||||||
|  |  | ||||||
| This is an example site for [Hugo](https://gohugo.io/). | 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/). | ||||||
|  |  | ||||||
| It is intended to be a demo site for the various [Hugo themes](https://themes.gohugo.io/). |  | ||||||
|  |  | ||||||
| # Using | # Using | ||||||
|  |  | ||||||
| @@ -12,15 +10,13 @@ It is intended to be a demo site for the various [Hugo themes](https://themes.go | |||||||
| git clone https://github.com/gohugoio/hugoBasicExample.git | git clone https://github.com/gohugoio/hugoBasicExample.git | ||||||
| cd hugoBasicExample | cd hugoBasicExample | ||||||
| ``` | ``` | ||||||
| 3. Clone the repository you want to test. If you want to test all hugo themes, you can clone [the full list](https://github.com/gohugoio/hugoThemes) | 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 |  | ||||||
| git clone --recursive https://URL/OF/YOUR/THEME themes/YOURTHEME |  | ||||||
| ``` |  | ||||||
| or |  | ||||||
| ```bash |  | ||||||
| git clone --recursive https://github.com/gohugoio/hugoThemes.git themes |  | ||||||
| ``` |  | ||||||
| 4. Run Hugo and select the theme of your choosing | 4. Run Hugo and select the theme of your choosing | ||||||
| ```bash | ```bash | ||||||
| hugo server -t YOURTHEME | 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 | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 Alexandros
					Alexandros