diff options
Diffstat (limited to 'exampleSite/content/post/Getting Started.md')
| -rw-r--r-- | exampleSite/content/post/Getting Started.md | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/exampleSite/content/post/Getting Started.md b/exampleSite/content/post/Getting Started.md index f551544..55eef3e 100644 --- a/exampleSite/content/post/Getting Started.md +++ b/exampleSite/content/post/Getting Started.md @@ -2,6 +2,7 @@ title: "Getting started with Vibrant Shadows" author: "Sanmay Joshi" description: "Read the full post to easily get started with Vibrant Shadows Hugo theme." +tags: ["get started", "guide"] date: "2020-09-30" --- It's very easy to get started with Vibrant Shadows. How? Read on. @@ -10,13 +11,13 @@ It's very easy to get started with Vibrant Shadows. How? Read on. ## Prerequisites -Firstly, *ensure you have installed the [extended version of Hugo](https://github.com/gohugoio/hugo/releases)*. You may need to scroll down a bit to see extended versions. Alternatively, you may see installation steps from [Hugo's official docs](https://gohugo.io/getting-started/installing/). +Firstly, *ensure you have installed the latest (min v0.75.1) [extended version of Hugo](https://github.com/gohugoio/hugo/releases)*. You may need to scroll down a bit to see extended versions. Alternatively, you may see installation steps from [Hugo's official docs](https://gohugo.io/getting-started/installing/). If you don't have or can't have extended version of Hugo installed, copy the resources folder from theme to root of your Hugo website directory. Hugo autodetects required files, and uses them. ## Getting up and running -Read the [prerequisites](#prerequisites) above and verify you're using the extended version of Hugo. There are at least two ways of quickly getting started with Hugo and the VMware Clarity theme: +Read the [prerequisites](#prerequisites) above and verify you're using the extended version of Hugo. There are at least two ways of quickly getting started with Hugo and the Vibrant Shadows theme: ### Setting up new Hugo website @@ -31,7 +32,7 @@ Simply add the repo to your theme option in `config.yaml`: ```yaml theme: - - github.com/Softorage/gohugo-theme-ananke + - github.com/Softorage/HugoTheme-VibrantShadows ``` #### 2. As Git Submodule @@ -40,8 +41,8 @@ Inside the folder of your Hugo site run: ```bash git init # to initiate git if it isn't already -git submodule add https://github.com/Softorage/gohugo-theme-ananke.git themes/ananke # add theme as a git submodule -cp -a themes/hugo-shadows/exampleSite/* . # we currently have Hugo Basic Example as our `exampleSite` +git submodule add https://github.com/Softorage/HugoTheme-VibrantShadows.git themes/vibrant-shadows # add theme as a git submodule +cp -a themes/vibrant-shadows/exampleSite/* . # ``` Then run @@ -52,11 +53,13 @@ hugo server And, we're done! +After setting up the theme, copy the `postcss.config.js` file to the rrot of your Hugo Website directory. We also recommend creating a `package.json` file in your Hugo Website directory. + ### Using boilerplate provided -1. Copy exampleSite folder provided. +1. Copy exampleSite folder provided, and move into this folder (open this folder). 2. Then run `hugo server` in terminal. And, we're done! -Once set, jump over to the `config.yaml` file and start [configuring](/post/configuration/) your site. +Once set, jump over to the `config.yaml` file and start [configuring](/post/configuration) your site. |