Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix format of the netlify makefile example #785

Merged
merged 1 commit into from
Feb 11, 2024
Merged

docs: fix format of the netlify makefile example #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .markdownlint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ MD041: False
MD042: False
MD004:
style: dash
MD010:
code_blocks: False
23 changes: 13 additions & 10 deletions exampleSite/content/en/usage/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ curl -L /~https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo
### Option 2: Clone the GitHub repository

{{< hint type=note >}}
**Info**\
Keep in mind this method is not recommended and needs some extra steps to get it working.
If you want to use the Theme as submodule keep in mind that your build process need to
run the described steps as well.
Expand All @@ -119,12 +118,17 @@ There are several ways to deploy your site with this theme on Netlify. Regardles

Here are some possible solutions:

**Use a Makefile:**
#### Use a Makefile

Add a Makefile to your repository to bundle the required steps.

{{< hint type=important >}}
The `Makefile` is only an example. Depending on your project structure, `BASEDIR` or `THEMEDIR` may need to be adapted.
{{< /hint >}}

```makefile
THEME_VERSION := v0.8.2
# Please change the theme version to the latest release version.
THEME_VERSION := v0.44.1
THEME := hugo-geekdoc
BASEDIR := docs
THEMEDIR := $(BASEDIR)/themes
Expand All @@ -134,17 +138,17 @@ doc: doc-assets doc-build

.PHONY: doc-assets
doc-assets:
mkdir -p $(THEMEDIR)/$(THEME)/ ; \
curl -sSL "/~https://github.com/thegeeklab/$(THEME)/releases/download/${THEME_VERSION}/$(THEME).tar.gz" | tar -xz -C $(THEMEDIR)/$(THEME)/ --strip-components=1
mkdir -p $(THEMEDIR)/$(THEME)/ ; \
curl -sSL "/~https://github.com/thegeeklab/$(THEME)/releases/download/${THEME_VERSION}/$(THEME).tar.gz" | tar -xz -C $(THEMEDIR)/$(THEME)/ --strip-components=1

.PHONY: doc-build
doc-build:
cd $(BASEDIR); hugo
cd $(BASEDIR); hugo

.PHONY: clean
clean:
rm -rf $(THEMEDIR) && \
rm -rf $(BASEDIR)/public
rm -rf $(THEMEDIR) && \
rm -rf $(BASEDIR)/public
```

This Makefile can be used in your `netlify.toml`, take a look at the [Netlify example](https://docs.netlify.com/configure-builds/file-based-configuration/#sample-netlify-toml-file) for more information:
Expand All @@ -155,7 +159,7 @@ publish = "docs/public"
command = "make doc"
```

**Chain required commands:**
#### Chain required commands

Chain all required commands to prepare the theme and build your site on the `command` option in your `netlify.toml` like this:

Expand All @@ -168,7 +172,6 @@ command = "command1 && command 2 && command3 && hugo"
### Subdirectories

{{< hint type=important >}}
**Warning**\
As deploying Hugo sites on subdirectories is not as robust as on subdomains, we do not recommend this.
If you have a choice, using a domain/subdomain should always be the preferred solution!
{{< /hint >}}
Expand Down