mirror of https://github.com/luizdepra/hugo-coder.git

Lucas de Oliveira
23.25.2023 09e04bcbb5d74316b6f2e36c088acd745ab11e1e
refs
author Lucas de Oliveira <lucasvitalate@gmail.com>
Monday, January 23, 2023 00:25 +0100
committer GitHub <noreply@github.com>
Monday, January 23, 2023 00:25 +0100
commit09e04bcbb5d74316b6f2e36c088acd745ab11e1e
tree ff45793051ea5c5331c39362f21af539a67294bc tree | zip | gz
parent 5cd634aa14645ffc59632d5e0eec3eec317dbc4f view | diff
Comment custom files on minimal configuration documentation (#767)

### Prerequisites

Put an `x` into the box(es) that apply:

- [X] This pull request fixes a bug.
- [ ] This pull request adds a feature.
- [ ] This pull request introduces breaking change.

### Description

This pull request allows a user to follow the Getting started
documentation and successfully build a hugo site using the hugo-coder
theme.

Currently, if you just follow the quick-start documentation using the
[minimal
config.toml](https://github.com/luizdepra/hugo-coder/blob/main/docs/configurations.md#complete-example)https://github.com/luizdepra/hugo-coder/blob/main/docs/configurations.md#complete-example
you won't be able to start the server, due the following errors

The issue is being solved by simply commenting the custom files on the
documentation, so anyone that follows the documentation will be able to
run the hugo site.

### Issues Resolved

- #766

### Checklist

Put an `x` into the box(es) that apply:

#### General

- [X] Describe what changes are being made
- [X] Explain why and how the changes were necessary and implemented
respectively
- [X] Reference issue with `#<ISSUE_NO>` if applicable

#### Resources

- [ ] If you have changed any SCSS code, run `make release` to
regenerate all CSS files

#### Contributors

- [X] Add yourself to `CONTRIBUTORS.md` if you aren't on it already

Signed-off-by: Lucas de Oliveira <lucasvitalate@gmail.com>
Co-authored-by: Luiz F. A. de PrĂ¡ <luizdepra@users.noreply.github.com>
1 files modified
8 ■■■■ changed files
docs/configurations.md 8 ●●●● diff | view | raw | blame | history