hugo-simpleIntro/README.md

88 lines
1.5 KiB
Markdown
Raw Normal View History

2020-08-13 06:38:17 -05:00
# Simple Intro
simple theme for hugo
![intro](imgaes/img1.png)
# Live Demo
2020-08-13 07:26:05 -05:00
https://gangjun06.github.io/hugo-theme-simple-intro-demo
2020-08-13 06:38:17 -05:00
2020-08-13 07:39:50 -05:00
[Demo Source Code](https://github.com/gangjun06/hugo-theme-simple-intro-demo)
2020-08-13 06:38:17 -05:00
2020-08-13 07:26:05 -05:00
# 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
```
config.toml
```toml
baseURL = "/"
languageCode = "en-us"
theme = "simple-intro"
title = "Title"
[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
"""
```
2020-08-15 04:50:08 -05:00
# Credits
| Name | License |
|---------------------------|--------------------|
| github.com/gohugoio/hugo | Apache License 2.0 |
| github.com/konpa/devicon/ | MIT License |