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

github.com/zwbetz-gh/vanilla-bootstrap-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZachary Betz <zwbetz@gmail.com>2018-12-30 02:37:48 +0300
committerZachary Betz <zwbetz@gmail.com>2018-12-30 02:37:48 +0300
commitbe5c680a1f2add3044b9d413a1ee0549387ffb05 (patch)
treed666dfbf455dfaf2c8ed0c7c11ebf43687a8ed6f
parentea50676e72d2986199b06bee016b468e6a6a8969 (diff)
Show how to run against example site
-rw-r--r--README.md15
-rw-r--r--local-development.md13
2 files changed, 15 insertions, 13 deletions
diff --git a/README.md b/README.md
index 5a5ee5b..6afc797 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ A vanilla [Bootstrap](https://getbootstrap.com/) theme for [Hugo](https://gohugo
* [Minimum Hugo Version](#minimum-hugo-version)
* [Installation](#installation)
* [Updating](#updating)
+* [Run Against the Example Site Locally](#run-against-the-example-site-locally)
* [Configuration](#configuration)
* [Shortcodes](#shortcodes)
* [bootstrap-blockquote](#bootstrap-blockquote)
@@ -39,6 +40,20 @@ git submodule add https://github.com/zwbetz-gh/vanilla-bootstrap-hugo-theme.git
git submodule update --remote --merge
```
+## Run Against the Example Site Locally
+
+From the root of the theme directory:
+
+```
+hugo server \
+--gc \
+--renderToDisk \
+--source exampleSite \
+--config exampleSite/config.yaml \
+--themesDir ../.. \
+--theme vanilla-bootstrap-hugo-theme
+```
+
## Configuration
Copy the `config.toml` or `config.yaml` from the [`exampleSite`](https://github.com/zwbetz-gh/vanilla-bootstrap-hugo-theme/tree/master/exampleSite), then edit as desired. Make sure to **uncomment** the `theme` line.
diff --git a/local-development.md b/local-development.md
deleted file mode 100644
index 48d3dbf..0000000
--- a/local-development.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Local Development
-
-Use the example site with the theme locally:
-
-```
-hugo server \
---gc \
---renderToDisk \
---source exampleSite \
---config exampleSite/config.yaml \
---themesDir ../.. \
---theme vanilla-bootstrap-hugo-theme
-```