Skip to content

Commit

Permalink
Remove installation as git submodule (config, doc)
Browse files Browse the repository at this point in the history
  • Loading branch information
deining authored and StefMa committed Mar 3, 2023
1 parent c6652ee commit cac6a3b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 39 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
public
.hugo_build.lock
2 changes: 2 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ module:
mounts:
- source: bulma.sass
target: assets/bulma/bulma.sass
- source: bulma-rtl.sass
target: assets/bulma/bulma-rtl.sass
- source: sass
target: assets/bulma/sass
- source: sass/base
Expand Down
40 changes: 3 additions & 37 deletions docs/content/getstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,35 +13,9 @@ include_footer: false

## Getting started

To create a new site using this theme
To create a new site using this theme as hugo module:

<details open>
<summary>with git submodules</summary>

```bash
# Create site and cd into it
hugo new site my-site && cd my-site

# Clone the Fresh theme
git clone https://github.com/StefMa/hugo-fresh themes/hugo-fresh

# Remove the default config
rm config.toml

# Fetch the example config
curl -O https://raw.githubusercontent.com/StefMa/hugo-fresh/master/exampleSite/hugo.yaml

# Run the site locally
hugo server

# Open the site in your browser
open http://localhost:1313
```

</details>

<details>
<summary>with hugo modules</summary>
Make sure `go` > 1.13 is installed on your system. [Download](https://go.dev/dl/) and install if needed.

```bash
# Create site and cd into it
Expand All @@ -54,13 +28,7 @@ hugo mod init YOUR_MODULE_NAME
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
curl -O https://raw.githubusercontent.com/StefMa/hugo-fresh/master/exampleSite/hugo.yaml

# Run the site locally
hugo server
Expand All @@ -69,8 +37,6 @@ hugo server
open http://localhost:1313
```

</details>

## Customizing your page

Checkout the [Landing page docs](../landingpage) to customize the landing page.
Expand Down
3 changes: 3 additions & 0 deletions exampleSite/hugo.work
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
go 1.19

use ../
10 changes: 8 additions & 2 deletions exampleSite/hugo.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
baseURL: http://something-fresh.org/
languageCode: en-us
title: Hugo Fresh Theme
# theme: hugo-fresh
theme: github.com/StefMa/hugo-fresh

module:
# uncomment line below for local development of module
# workspace: hugo.work
imports:
path: github.com/StefMa/hugo-fresh


googleAnalytics: # Put in your tracking code without quotes like this: UA-XXXXXX...
# Disables warnings
disableKinds:
Expand Down

0 comments on commit cac6a3b

Please sign in to comment.