jcarr
/
hugo-simpleIntro
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update reacdme, exampleSite

This commit is contained in:
gangjun06 2020-08-15 10:24:57 +00:00
parent 5fa604ad3a
commit c7e664c705
8 changed files with 100 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
LICENSE
View File

@ -1,20 +0,0 @@
The MIT License (MIT)
Copyright (c) 2020 YOUR_NAME_HERE
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

76
README.md
View File

@ -4,85 +4,23 @@ simple theme for hugo
![intro](imgaes/img1.png)
# Live Demo
https://gangjun06.github.io/hugo-theme-simple-intro-demo
https://gangjun06.github.io/SimpleIntroDemo
[Demo Source Code](https://github.com/gangjun06/hugo-theme-simple-intro-demo)
# Get Started
```bash
hugo new site <site-name>
cd <site-name>
git submodule add https://github.com/gangjun06/hugo-theme-simple-intro themes/simple-intro
# Apply config
hugo serve -D
git submodule add https://github.com/gangjun06/SimpleIntro themes/SimpleIntro
```
config.toml
```toml
baseURL = "/"
languageCode = "en-us"
theme = "simple-intro"
title = "Title"
# Configuration
Check out the config files included on the [exampleSite](exampleSite)
[params]
mainbg = "backroundImage Path"
name = "Your Name"
mainTitle = "Header Title"
mainText = "Header Text"
[menus]
[[menu.main]]
identifier = "about"
name = "About"
url = "#about"
[[menu.main]]
identifier = "skills"
name = "Skills"
url = "#skills"
[[menu.main]]
identifier = "projects"
name = "Projects"
url = "#projects"
```
data/home/about.toml
```toml
title = "about title"
text = """
about text
"""
[[link]]
icon = "fontawesome icon"
link = "#"
```
data/home/project.toml
```toml
[[list]]
title = "project name"
image = "Project image"
text = """
project description
"""
```
data/home/skills.toml
```toml
[[list]]
name = "lang Name"
icon = "lang Icon"
text = """
skill text
"""
```
# Credits
| Name | License |
|---------------------------|--------------------|
| github.com/gohugoio/hugo | Apache License 2.0 |
| github.com/konpa/devicon/ | MIT License |
| Name | License | Description |
|---------------------------|-------------|----------------|
| github.com/konpa/devicon/ | MIT License | Demo Site Icon |

2
archetypes/default.md
View File

@ -1,2 +0,0 @@
+++
+++

25
exampleSite/config.toml Normal file
View File

@ -0,0 +1,25 @@
baseURL = ""
languageCode = "en-us"
theme = "SimpleIntro"
title = "Theme Demo"
publishDir = "public"
[params]
mainbg = "https://picsum.photos/1920/1080"
name = "John Doe"
mainTitle = "Simple-intro"
mainText = "Just simple intro theme for hugo"
[menus]
[[menu.main]]
identifier = "about"
name = "About"
url = "#about"
[[menu.main]]
identifier = "skills"
name = "Skills"
url = "#skills"
[[menu.main]]
identifier = "projects"
name = "Projects"
url = "#projects"

23
exampleSite/data/home/about.toml Normal file
View File

@ -0,0 +1,23 @@
title = "Hello, World!"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""
[[link]]
icon = "fab fa-github"
url = "#"
[[link]]
icon = "fab fa-linkedin"
url = "#"
[[link]]
icon = "fas fa-envelope"
url = "#"
[[link]]
icon = "fab fa-instagram"
url = "#"
[[link]]
icon = "fab fa-facebook"
url = "#"

16
exampleSite/data/home/project.toml Normal file
View File

@ -0,0 +1,16 @@
[[list]]
title = "lorem"
image = "https://picsum.photos/400/200"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""
[[list]]
title = "lorem"
image = "https://picsum.photos/400/200"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""

24
exampleSite/data/home/skills.toml Normal file
View File

@ -0,0 +1,24 @@
[[list]]
name = "go"
icon = "https://devicons.github.io/devicon/devicon.git/icons/go/go-original.svg"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""
[[list]]
name = "React"
icon = "https://devicons.github.io/devicon/devicon.git/icons/react/react-original.svg"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""
[[list]]
name = "C/C++"
icon = "https://devicons.github.io/devicon/devicon.git/icons/cplusplus/cplusplus-original.svg"
text = """
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Voluptatibus quia, nulla! Maiores et perferendis eaque,
exercitationem praesentium nihil.
"""

10
theme.toml
View File

@ -2,11 +2,11 @@
# See https://github.com/gohugoio/hugoThemes#themetoml for an example
name = "SimpleIntro"
license = "MIT"
licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE"
description = ""
homepage = "http://example.com/"
tags = []
license = "Apache-2.0"
licenselink = "https://github.com/gangjun06/SimpleIntro/blob/master/LICENSE"
description = "Simple Single-Page Theme For Hugo"
homepage = "https://github.com/gangjun06/SimpleIntro"
tags = ["clean", "simple", "responsive", "light", "single-page", ""]
features = []
min_version = "0.41.0"