diff options
| author | roninro <liumy.f@foxmail.com> | 2022-08-10 12:14:54 +0800 |
|---|---|---|
| committer | roninro <liumy.f@foxmail.com> | 2022-08-10 12:14:54 +0800 |
| commit | c6472f7098c7a8f85cee395934ba4e706d40b672 (patch) | |
| tree | 1ad3acc8ad15a3d0b1963d93726a67dd7c925dbb /exampleSite/content/posts/getting-started.md | |
| parent | dfb6b815514a14c311ee5a1027c8d2669f2430f8 (diff) | |
*
Diffstat (limited to 'exampleSite/content/posts/getting-started.md')
| -rw-r--r-- | exampleSite/content/posts/getting-started.md | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/exampleSite/content/posts/getting-started.md b/exampleSite/content/posts/getting-started.md new file mode 100644 index 0000000..59a94b9 --- /dev/null +++ b/exampleSite/content/posts/getting-started.md @@ -0,0 +1,95 @@ ++++ +title = "Puppet - Getting Started" +date = 2022-08-09T15:38:30+08:00 +draft = true +header_img = "" +short = false +toc = true +tags = ["documentation", "guide"] +categories = [] +series = ["Themes Guide"] ++++ + +Puppet is a responsive, simple and clean [Hugo](https://gohugo.io/) theme based on the [Huxblog Jekyll theme](https://github.com/Huxpro/huxpro.github.io). + +<!--more--> + +## Install Hugo + +Make sure you have installed the lastest version of [Hugo-extented](https://gohugo.io/getting-started/installing/). + +## Create a New Site + +``` +hugo new site mysite +``` + +## Add the Theme + +You can download and unpack the theme manually from Github or use git to clone the theme into your site's `themes` directory. + +```bash +cd mysite +git init +git clone https://github.com/roninro/hugo-theme-puppet.git themes/puppet +``` + +Or you can add the theme as a submodule. + +```bash +cd mysite +git init +git submodule add https://github.com/roninro/hugo-theme-puppet.git themes/puppet +git submodule update --init --recursive +``` + +That’s all, Puppet is ready to be used. + + +## Add Config Files + +For getting started, you can copy the `config.toml` file from the theme's exampleSite directory to the root directory of your site. + +```bash +cp themes/puppet/exampleSite/config.toml . +``` + +> Note: You may need to delete the `themesDir` line in the config file. + +## Add Some Content + +Create a new post with the following command. + +```bash +hugo new posts/my-first-post.md +``` + +Edit the content of the post. + +```markdown ++++ +title = "{{ replace .Name "-" " " | title }}" +date = {{ .Date }} +description = "" +draft = true +subtitle = "" +header_img = "" +toc = true +tags = [] +categories = [] +series = [] +comment = true ++++ + +Your content here... +``` + +Some front-matter used for SEO, others used for displaying contents, configuration, etc. + +## Run example site + +From the root of themes/puppet/exampleSite: + +```bash +hugo server --themesDir ../.. +``` |
