diff options
author | Igor Baiborodine <igor@kiroule.com> | 2022-02-15 20:54:04 +0300 |
---|---|---|
committer | Igor Baiborodine <igor@kiroule.com> | 2022-02-15 20:54:04 +0300 |
commit | 3b05d30309c9cdddc9af6633df8fd97e855485cf (patch) | |
tree | 35276fcb5cd4da66e170558caea4db44e1eef751 | |
parent | a5a2207cef20ab1201d136cf3fee03e67fb43f29 (diff) |
Temporarily remove quick start instructions for Hugo modules
-rw-r--r-- | README.md | 78 |
1 files changed, 6 insertions, 72 deletions
@@ -27,10 +27,6 @@ Please use the following guidelines if you want to start a discussion: - [Requirements](#requirements) - [Quick Start](#quick-start) - - [Create skeleton site](#create-skeleton-site) - - [Route 1 (recommended): use theme as module](#route-1-recommended-use-theme-as-module) - - [Route 2 (traditional): install theme locally](#route-2-traditional-install-theme-locally) - - [Start up your site](#start-up-your-site) - [Configuration](#configuration) - [Features](#features) - [Post Types](#post-types) @@ -81,96 +77,31 @@ Please use the following guidelines if you want to start a discussion: **Hugo version >= 0.77.0 required**; see this [guide](https://gohugo.io/getting-started/installing/) on how to install Hugo. Only when using theme as Hugo module: -**Go version >= 1.12 required**; download Go installer [here](https://go.dev/dl/) **Git required**; download Git installer [here](https://git-scm.com/downloads) ## Quick Start -### Create skeleton site - - Create a new site: ``` hugo new site my-new-blog ``` -- Enter site directory: -``` -cd my-new-blog -``` - -There are two routes to associate the `billberry` theme with your site: - -### Route 1 (recommended): use theme as module - -- Turn your new site into a Hugo module: -``` -hugo mod init github.com/me/my-new-blog -``` - -- Declare the `bilberry` module as a dependency of your site: -``` -hugo mod get github.com/Lednerb/bilberry-hugo-theme -``` - -- Add the following lines at the end of your `config.toml`: - -``` -[module] - [[module.imports]] - path = "github.com/Lednerb/bilberry-hugo-theme" - disable = false - [[module.imports.mounts]] - source = "exampleSite" - target = "assets/exampleSite" -``` - -- Vendor the theme into the `_vendor` directory: - -``` -hugo mod vendor -``` - -- Copy example site content including the `config.toml` file: -``` -cp -r _vendor/github.com/Lednerb/bilberry-hugo-theme/exampleSite/* . -``` - -- Delete the `_vendor` directory in your site root: - -``` -rm -rf _vendor/ -``` - -At the top of your config.toml, remove the hash sign at the beginning of the `theme =` line in order to activate your theme as module: - -``` -# using theme as Hugo module (uncomment to activate) -theme = "github.com/Lednerb/bilberry-hugo-theme" -``` - -### Route 2 (traditional): install theme locally - - Install the latest version of this theme: ``` -cd themes +cd my-new-blog/themes git clone https://github.com/Lednerb/bilberry-hugo-theme.git ``` -If you don't use **Git**, you can download this theme [here](https://github.com/Lednerb/bilberry-hugo-theme/archive/master.zip) and extract it manually into the `themes` folder. +If you don't use **Git**, you can download this theme [here](https://github.com/Lednerb/bilberry-hugo-theme/archive/master.zip) and extract it manually into the `themes` folder. Make sure the folder containing the extracted theme is named `bilberry-hugo-theme`. -**Important:** Do NOT change the name of the `bilberry-hugo-theme` folder. -Renaming this folder will break your site. - - Copy example site content including the `config.toml` file: ``` cp -r bilberry-hugo-theme/exampleSite/* ../ -cd ../ ``` -## Start up your site - - Remove the default archetype: ``` +cd ../ rm archetypes/default.md ``` @@ -179,6 +110,9 @@ rm archetypes/default.md hugo server ``` +**Important:** Do NOT change the name of the `bilberry-hugo-theme` folder. +Renaming this folder will break your site. + Also, check out this [tutorial](https://www.kiroule.com/article/start-blogging-with-github-hugo-and-netlify/) on how to build a Bilberry theme-based website using Hugo, GitHub, and Netlify. ## Configuration |