From cc31e5c6078f07cbb4608530d73c187dd76002ad Mon Sep 17 00:00:00 2001 From: StefMa Date: Mon, 15 Feb 2021 15:15:40 +0100 Subject: [PATCH] Document hugo modules usage --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 487012a..fd99178 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,10 @@ ## Getting started -To create a new site using this theme: +To create a new site using this theme + +
+with git submodules ```bash # Create site and cd into it @@ -28,6 +31,39 @@ hugo server open http://localhost:1313 ``` +
+ +
+with hugo modules + +```bash +# Create site and cd into it +hugo new site my-site && cd my-site + +# Transform your hugo site to an module +hugo mod init YOUR_MODULE_NAME + +# Remove the default config +rm config.toml + +# Fetch the example config +curl -O https://raw.githubusercontent.com/StefMa/hugo-fresh/master/exampleSite/config.yaml + +# Replace theme with module in config.yaml +#theme: [hugo-fresh] +module: + imports: + path: github.com/stefma/hugo-fresh + +# Run the site locally +hugo server + +# Open the site in your browser +open http://localhost:1313 +``` + +
+ ## Customizing your page ### Landing page