x0rg
/
agr.asia
forked from Git/hugo-story
1
0
Fork 0
Code Pull Requests Activity
agr.asia/README.md

95 lines
3.2 KiB
Markdown
Raw Normal View History

First Commit
2020-07-02 07:03:01 +02:00
# Hugo Story
## A (modular, highly tweakable) responsive one-page theme for Hugo.
Add Images Dir
2023-01-22 16:44:40 +01:00
![](images/device-screenshots.png)
First Commit
2020-07-02 07:03:01 +02:00
Update ReadMe
2020-07-24 23:56:19 +02:00
Hugo Story is a port of the static HTML template Story by HTML5 UP. It is designed to mirror the look and feel of the original template as closely as possible while incorporating some of the features Hugo has to offer.
This theme is designed for those who are comfortable editing HTML and integrating Hugo short codes and variables to customize the theme to their liking.
## Features
- Minimalist Design
- Fully Responsive
- Templates
- Header
- Footer
- FootScripts
- Favicon
- Partials for each element type
- Banner
- Spotlight
- Gallery
- Items
- Image gallery
- Short Codes
- Site Title
- Site Subtitle
- Site Logo
- Social Icons
- Favicon and Social icons
- FontAwesome Icon Support
- SASS and AutoMinify Support
- Google Analytics Support
First Commit
2020-07-02 07:03:01 +02:00
## Demo
https://caressofsteel.github.io/demos/hugo/hugo-story/
2023 Updates
2023-01-19 00:59:02 +01:00
First Commit
2020-07-02 07:03:01 +02:00
## Using
2023 Updates
2023-01-19 00:59:02 +01:00
### 1. Install Hugo.
Update Readme
2021-02-05 21:56:51 +01:00
[Install Hugo (Extended Version)](https://gohugo.io/overview/installing/)
> _This theme uses Hugo Pipes to compile SCSS & Sass so you'll have to use the **extended** version of Hugo. See the official [Hugo Quick Start Guide](https://gohugo.io/getting-started/quick-start/) for more information._
2023 Updates
2023-01-19 00:59:02 +01:00
### 2. Create a new example site called `mystory`.
Update Readme
2021-02-05 21:56:51 +01:00
```
2023 Updates
2023-01-19 00:59:02 +01:00
hugo new site mystory
Update Readme
2021-02-05 21:56:51 +01:00
```
2023 Updates
2023-01-19 00:59:02 +01:00
### 3. Clone the Git repository.
Update Readme
2021-02-05 21:56:51 +01:00
```
2023 Updates
2023-01-19 00:59:02 +01:00
cd mystory
change "add" to "clone" For a new install/site the "git add" command returns an error.
2022-06-02 20:34:07 +02:00
git clone https://github.com/caressofsteel/hugo-story.git themes/hugo-story
Update Readme
2021-02-05 21:56:51 +01:00
```
> _Hint: See a note for non-Git users [here](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme)._
2023 Updates
2023-01-19 00:59:02 +01:00
### 4. Copy contents of `themes/hugo-story/exampleSite/` to `mystory` root folder with overwrite.
Update Readme
2021-02-05 21:56:51 +01:00
```
2023 Updates
2023-01-19 00:59:02 +01:00
cp -r themes/hugo-story/exampleSite/* ./
Update Readme
2021-02-05 21:56:51 +01:00
```
Add Images Dir
2023-01-22 16:44:40 +01:00
> _Hint: This sets up the `mystory` example website with a copy of the theme `assets`, `layouts`, `data`, and `configuration` files in the site's root folder and outside of the theme folder._
Update Readme
2021-02-05 21:56:51 +01:00
Add Images Dir
2023-01-22 16:44:40 +01:00
> _Hint: Theme assets in the site root, `if present`, take precedence over files in the theme folder._
>
2023 Updates
2023-01-19 00:59:02 +01:00
### 5. Start Hugo Server.
Update Readme
2021-02-05 21:56:51 +01:00
```
hugo server
```
2023 Updates
2023-01-19 00:59:02 +01:00
### 6. Open Hugo Server in your browser.
Update Readme
2021-02-05 21:56:51 +01:00
```
http://localhost:1313/
```
Add Images Dir
2023-01-22 16:44:40 +01:00
Here you'll see the site running on the local Hugo server. You can now edit the theme and Hugo will rebuild the site when changes are detected.
Update Readme
2021-02-05 21:56:51 +01:00
2023 Updates
2023-01-19 00:59:02 +01:00
### 7. Further steps.
Update Readme
2021-02-05 21:56:51 +01:00
2023 Updates
2023-01-19 00:59:02 +01:00
- Edit the contents of `YML` files in the `data` folder.
Update Readme
2021-02-05 21:56:51 +01:00
- _Altering `banner.yml` will change the top block on the site. See more details [here](https://gohugo.io/templates/data-templates/)._
- Create a custom site layout.
2023 Updates
2023-01-19 00:59:02 +01:00
- Edit the `index.html` within `mystory/layouts/` to customize the layout the site.
First Commit
2020-07-02 07:03:01 +02:00
Update Readme
2021-02-05 21:56:51 +01:00
- By manipulating the the `{{ partial ... }}` tags within this file you can create a custom layout for the site. See more details [here](https://gohugo.io/templates/partials/).
adding steps into quick start guide
2021-02-04 23:23:52 +01:00
Update Readme
2021-02-05 21:56:51 +01:00
- Continue exploring Hugo and the template!
First Commit
2020-07-02 07:03:01 +02:00
## Credits
This theme was created using the _Story_ template by [HTML5 UP](https://html5up.net/uploads/demos/story/).
## License
<a rel="license" href="http://creativecommons.org/licenses/by/3.0/" class="license-button"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png"></a>
Fix possible typo in README The instructions for copying the `config.toml` is this: ``` cp themes/hugo-story/exampleSite/config.toml/ ``` But that turned out be an error when I tried it. This gets printed out in the terminal: ``` usage: cp [-R [-H | -L | -P]] [-fi | -n] [-apvXc] source_file target_file cp [-R [-H | -L | -P]] [-fi | -n] [-apvXc] source_file ... target_directory ``` I believe the correct instruction is this: ``` cp themes/hugo-story/exampleSite/config.toml ./ ```
2021-03-22 20:04:07 +01:00
This Hugo theme is licensed under the [Creative Commons Attribution 3.0 License](LICENSE).