Update README.md
This commit is contained in:
parent
162234fa25
commit
8aa8f6e48b
1 changed files with 48 additions and 43 deletions
91
README.md
91
README.md
|
|
@ -1,4 +1,4 @@
|
||||||
<h1 align=center>Hugo Scroll <a href="https://zjedi.github.io/hugo-scroll/" rel="nofollow">Demo</a></h1>
|
<h1 align=center>Hugo Scroll 📜 <a href="https://zjedi.github.io/hugo-scroll/" rel="nofollow">Demo</a></h1>
|
||||||
|
|
||||||
Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme.
|
Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme.
|
||||||
|
|
||||||
|
|
@ -9,7 +9,7 @@ Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme.
|
||||||
Promo image which may be a bit outdated:<br/>
|
Promo image which may be a bit outdated:<br/>
|
||||||

|

|
||||||
|
|
||||||
## Feature highlights
|
## ⭐ Feature highlights
|
||||||
- Responseive to screen size/shape
|
- Responseive to screen size/shape
|
||||||
- SEO friendly
|
- SEO friendly
|
||||||
- Customizable
|
- Customizable
|
||||||
|
|
@ -17,45 +17,11 @@ Promo image which may be a bit outdated:<br/>
|
||||||
- Header logo
|
- Header logo
|
||||||
- Visual guards to guarantee readability
|
- Visual guards to guarantee readability
|
||||||
- External links
|
- External links
|
||||||
- JS/CSS Assets optimized (Minification, Fingerpriting, pipeline-processed into single file)
|
- JS/CSS Assets optimized (Minification, Fingerpriting, pipeline-processed
|
||||||
|
into single file)
|
||||||
|
- git info in footer (opt-in)
|
||||||
|
|
||||||
## Feature details
|
## 🔑 Installation
|
||||||
### Icons
|
|
||||||
This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{<icon>}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la
|
|
||||||
```markdown
|
|
||||||
Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-)
|
|
||||||
```
|
|
||||||
### Header logo
|
|
||||||
Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"`
|
|
||||||
|
|
||||||
### Footer version information
|
|
||||||
In order to see technical version information (extracted from Hugo's [GitInfo](https://gohugo.io/variables/git/))) set the following general option in your config.toml: `enableGitInfo = true`
|
|
||||||
|
|
||||||
### External links
|
|
||||||
You can add an external link in the menu, see `external.md` in the `exampleSite`.
|
|
||||||
|
|
||||||
You can also use `extlink` shortcode to create a link opening in a new tab:
|
|
||||||
```markdown
|
|
||||||
Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
|
|
||||||
```
|
|
||||||
Referencing and showing icons in front of the link text is possible with a new parameter `icon`:
|
|
||||||
```markdown
|
|
||||||
Visit as at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Customizing CSS
|
|
||||||
Add a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory.
|
|
||||||
- You can use `<style>` tag to embed the overrides (better performance-wise)
|
|
||||||
- Alternatively you can `<link>` your own `custom.css`
|
|
||||||
|
|
||||||
`CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding
|
|
||||||
```scss
|
|
||||||
:root {
|
|
||||||
--some-var-name: blue!important;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
If you already have a Hugo site on your machine, you can simply add this theme via
|
If you already have a Hugo site on your machine, you can simply add this theme via
|
||||||
```
|
```
|
||||||
git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll
|
git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll
|
||||||
|
|
@ -81,7 +47,46 @@ You can add **a new section to the homepage** by running `hugo new homepage/my-n
|
||||||
|
|
||||||
To create **a page separate from the homepage**, run `hugo new my-new-page.md`
|
To create **a page separate from the homepage**, run `hugo new my-new-page.md`
|
||||||
|
|
||||||
## Issues / Feedback / Contributing
|
|
||||||
|
## 🔧 Feature details 🔨
|
||||||
|
|
||||||
|
### Customizing CSS
|
||||||
|
Add a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory.
|
||||||
|
- You can use `<style>` tag to embed the overrides (better performance-wise)
|
||||||
|
- Alternatively you can `<link>` your own `custom.css`
|
||||||
|
|
||||||
|
`CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding
|
||||||
|
```scss
|
||||||
|
:root {
|
||||||
|
--some-var-name: blue!important;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
### Icons
|
||||||
|
This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{<icon>}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la
|
||||||
|
```markdown
|
||||||
|
Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-)
|
||||||
|
```
|
||||||
|
### Header logo
|
||||||
|
Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"`
|
||||||
|
|
||||||
|
### Footer version information
|
||||||
|
In order to see technical version information (extracted from Hugo's [GitInfo](https://gohugo.io/variables/git/))) set the following general option in your config.toml: `enableGitInfo = true`
|
||||||
|
|
||||||
|
### External links
|
||||||
|
You can add an external link in the menu, see `external.md` in the `exampleSite`.
|
||||||
|
|
||||||
|
You can also use `extlink` shortcode to create a link opening in a new tab:
|
||||||
|
```markdown
|
||||||
|
Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
|
||||||
|
```
|
||||||
|
Referencing and showing icons in front of the link text is possible with a new parameter `icon`:
|
||||||
|
```markdown
|
||||||
|
Visit as at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🐛 Issues / 💡 Feedback / 👑 Contributing
|
||||||
[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
|
[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
|
||||||
[Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking,
|
[Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking,
|
||||||
[Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) for contributions.
|
[Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) for contributions.
|
||||||
|
|
@ -89,10 +94,10 @@ To create **a page separate from the homepage**, run `hugo new my-new-page.md`
|
||||||
|
|
||||||
See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.
|
See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.
|
||||||
|
|
||||||
## Special Thanks 🎁
|
## 👏 Special Thanks
|
||||||
- [Jan Raasch](https://www.janraasch.com), original author of theme
|
- [Jan Raasch](https://www.janraasch.com), original author of theme
|
||||||
- [Yonatan Wolowelsky](https://github.com/grmmph), author of [GhostScroll](https://github.com/grmmph/GhostScroll) theme, which formed the basis of this [Hugo](https://gohugo.io/) theme.
|
- [Yonatan Wolowelsky](https://github.com/grmmph), author of [GhostScroll](https://github.com/grmmph/GhostScroll) theme, which formed the basis of this [Hugo](https://gohugo.io/) theme.
|
||||||
- [Pexels](https://www.pexels.com), for supplying those wonderful _free_ stock photos on the [exampleSite](https://github.com/zjedi/hugo-scroll/tree/master/exampleSite).
|
- [Pexels](https://www.pexels.com), for supplying _free_ stock photos.
|
||||||
|
|
||||||
|
|
||||||
[hugo-setup-guide]: https://gohugo.io/getting-started/installing
|
[hugo-setup-guide]: https://gohugo.io/getting-started/installing
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue