mirror of
https://github.com/TeamPiped/hugo-whisper-theme.git
synced 2024-08-14 23:57:00 +00:00
first commit
This commit is contained in:
commit
dcdde20b7c
179 changed files with 16070 additions and 0 deletions
21
exampleSite/content/docs/_index.md
Normal file
21
exampleSite/content/docs/_index.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: 'Overview'
|
||||
date: 2018-11-28T15:14:39+10:00
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Make Beautiful Docs
|
||||
|
||||
Whisper is a minimal documentation theme for Hugo. The design and functionality is intentionally minimal. We’re aiming for a similar feel to a Github readme.
|
||||
|
||||
```javascript
|
||||
var body = document.querySelector('body');
|
||||
var menuTrigger = document.querySelector('#toggle-main-menu-mobile');
|
||||
var menuContainer = document.querySelector('#main-menu-mobile');
|
||||
|
||||
menuTrigger.onclick = function() {
|
||||
menuContainer.classList.toggle('open');
|
||||
menuTrigger.classList.toggle('is-active');
|
||||
body.classList.toggle('lock-scroll');
|
||||
};
|
||||
```
|
39
exampleSite/content/docs/configure/index.md
Normal file
39
exampleSite/content/docs/configure/index.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: 'Configuration'
|
||||
date: 2019-02-11T19:30:08+10:00
|
||||
draft: false
|
||||
weight: 4
|
||||
---
|
||||
|
||||
### Homepage meta tags
|
||||
|
||||
Often a homepage requires special meta tags such as a meta description or og meta data for twitter, facebook etc. You can configure these values in the `config.toml`
|
||||
|
||||
```
|
||||
// config.toml
|
||||
[params]
|
||||
google_analytics_id=""
|
||||
|
||||
[params.homepage_meta_tags]
|
||||
meta_description = "a description of your website."
|
||||
meta_og_title = "My Theme"
|
||||
meta_og_type = "website"
|
||||
meta_og_url = "https://www.mywebsite.com"
|
||||
meta_og_image = "https://www.mywebsite.com/images/tn.png"
|
||||
meta_og_description = "a description of your website."
|
||||
meta_twitter_card = "summary"
|
||||
meta_twitter_site = "@mytwitterhandle"
|
||||
meta_twitter_creator = "@mytwitterhandle"
|
||||
```
|
||||
|
||||
### Set meta tags on a per template/page basis
|
||||
|
||||
You can set meta tags on a per template basis using a block. For example, you might want to write a custom meta description for the `/services` page. You can insert any valid HTML meta data inside the `{{ define "meta_tags }}` block at the top of a template.
|
||||
|
||||
```
|
||||
// layouts/services/list.html
|
||||
...
|
||||
|
||||
{{ define "meta_tags" }}
|
||||
<meta name="description" content="We offer a variety of services in the finance industry" />
|
||||
```
|
15
exampleSite/content/docs/install-hugo/index.md
Normal file
15
exampleSite/content/docs/install-hugo/index.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: 'Install Hugo'
|
||||
date: 2019-02-11T19:27:37+10:00
|
||||
weight: 2
|
||||
---
|
||||
|
||||
To use this theme you will need to have Hugo installed. If you don't already have Hugo installed please follow the official [installation guide](https://gohugo.io/getting-started/installing/)
|
||||
|
||||
### Check Hugo Version
|
||||
|
||||
This theme uses [Hugo Pipes](https://gohugo.io/hugo-pipes/scss-sass/) to compile SCSS and minify assets. Please make sure you have the `Hugo Extended` version installed. If you are not using the extended version this theme will not not compile.
|
||||
|
||||
```
|
||||
hugo version
|
||||
```
|
62
exampleSite/content/docs/installation/index.md
Normal file
62
exampleSite/content/docs/installation/index.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
title: 'Installation'
|
||||
date: 2019-02-11T19:27:37+10:00
|
||||
draft: false
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## Create a new Hugo site
|
||||
|
||||
```
|
||||
hugo new site mynewsite
|
||||
```
|
||||
|
||||
This will create a fresh Hugo site in the folder `mynewsite`.
|
||||
|
||||
## Install theme
|
||||
|
||||
Copy or git clone this theme into the sites themes folder `mynewsite/themes`
|
||||
|
||||
#### Install with Git
|
||||
|
||||
```
|
||||
cd mynewsite
|
||||
cd themes
|
||||
git clone https://github.com/jugglerx/hugo-hero-theme.git
|
||||
```
|
||||
|
||||
#### Install from .zip file
|
||||
|
||||
You can download the .zip file located here https://github.com/JugglerX/hugo-hero-theme/archive/master.zip.
|
||||
|
||||
Extract the downloaded .zip inside the `themes` folder. Rename the extracted folder from `hugo-hero-theme-master` -> `hugo-hero-theme`. You should end up with the following folder structure `mynewsite/themes/hugo-hero-theme`
|
||||
|
||||
### Add example content
|
||||
|
||||
The fastest way to get started is to copy the example content. Copy the entire contents of the `exampleSite` folder to the root folder of your Hugo site (the folder with the README.md).
|
||||
|
||||
### Update config.toml
|
||||
|
||||
After you copy the `config.toml` into the root folder of your Hugo site you will need to update the `baseURL`, `themesDir` and `theme` values in the `config.toml`
|
||||
|
||||
```
|
||||
baseURL = "/"
|
||||
themesDir = "themes"
|
||||
theme = "hugo-hero-theme"
|
||||
```
|
||||
|
||||
### Run Hugo
|
||||
|
||||
After installing the theme for the first time, generate the Hugo site.
|
||||
|
||||
```
|
||||
hugo
|
||||
```
|
||||
|
||||
For local development run Hugo's built-in local server.
|
||||
|
||||
```
|
||||
hugo server
|
||||
```
|
||||
|
||||
Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
|
BIN
exampleSite/content/docs/netlify/image2.png
Normal file
BIN
exampleSite/content/docs/netlify/image2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 52 KiB |
19
exampleSite/content/docs/netlify/index.md
Normal file
19
exampleSite/content/docs/netlify/index.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: 'Netlify'
|
||||
date: 2018-11-28T15:14:39+10:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
# Netlify Index
|
||||
|
||||
# Using exampleSite With Netlify
|
||||
|
||||
Lorem markdownum, dictis umbrosum dextrum, Lelegeia quamquam distantes pares
|
||||
ignisque quaerit dederat gemino Aethiopesque [caelo](#inque-ne-collocat)
|
||||
ulciscitur est. Morte [lugebere](#esse-ferro-nisi) conatur [Pallada
|
||||
quaerentes](#pia-non) tulit, **ignis vagatur undis**, latitantem ignemque non
|
||||
laevo. Terras seu favoni tectas movit hunc motuque damno tutoque quattuor. Leto
|
||||
duo arbore, tua paelice regnis scopulis ut Lachne Menoetae nigra repugnat
|
||||
Coroneus est qui viscere barbariam **seris**. Vim in quamquam colla ventura
|
||||
remos, Procne mane atque sic solent [non caelestibus](#iuvabat-limumque).
|
Loading…
Add table
Add a link
Reference in a new issue