Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gangjun06/SimpleIntro.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgangjun06 <me@gangjun.dev>2020-08-13 15:26:05 +0300
committergangjun06 <me@gangjun.dev>2020-08-13 15:26:05 +0300
commit1c5cb37ef1d275e4be29859858ff8a1d58ac62bc (patch)
tree00e956428fef34b9cb966094b1ff03f641674dcf
parent08882d82a53ff618a28196072090e2c3b696a506 (diff)
.
-rw-r--r--README.md76
-rw-r--r--exampleSite/.gitignore1
-rw-r--r--exampleSite/archetypes/default.md6
-rw-r--r--exampleSite/config.toml3
-rw-r--r--exampleSite/themes/CLONE_THEME_HERE0
5 files changed, 81 insertions, 5 deletions
diff --git a/README.md b/README.md
index ba221b3..a6736e4 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,78 @@ simple theme for hugo
![intro](imgaes/img1.png)
# Live Demo
-https://gangjun06.github.io/hugo-theme-simple-intro
+https://gangjun06.github.io/hugo-theme-simple-intro-demo
-# Configure
+[Demo Source Code](exampleSite)
-see [this](exampleSite) \ No newline at end of file
+# 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
+ """
+```
diff --git a/exampleSite/.gitignore b/exampleSite/.gitignore
new file mode 100644
index 0000000..d373863
--- /dev/null
+++ b/exampleSite/.gitignore
@@ -0,0 +1 @@
+themes/simple-intro \ No newline at end of file
diff --git a/exampleSite/archetypes/default.md b/exampleSite/archetypes/default.md
new file mode 100644
index 0000000..00e77bd
--- /dev/null
+++ b/exampleSite/archetypes/default.md
@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index e36b2a4..cd1e022 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -21,5 +21,4 @@ title = "Theme Demo"
[[menu.main]]
identifier = "projects"
name = "Projects"
- url = "#projects"
- \ No newline at end of file
+ url = "#projects" \ No newline at end of file
diff --git a/exampleSite/themes/CLONE_THEME_HERE b/exampleSite/themes/CLONE_THEME_HERE
deleted file mode 100644
index e69de29..0000000
--- a/exampleSite/themes/CLONE_THEME_HERE
+++ /dev/null