소스 검색

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>
Lucas de Oliveira 2 년 전
부모
커밋
09e04bcbb5
1개의 변경된 파일4개의 추가작업 그리고 4개의 파일을 삭제
  1. 4 4
      docs/configurations.md

+ 4 - 4
docs/configurations.md

@@ -138,7 +138,7 @@ Follow [these steps](https://gohugo.io/content-management/comments/#configure-di
 ```toml
 [params.giscus] # https://giscus.app
   repo = ""
-  repoID = "" 
+  repoID = ""
   category = ""
   categoryID = ""
   mapping = ""
@@ -319,9 +319,9 @@ disqusShortname = "yourdiscussshortname"
   colorScheme = "auto"
   hidecolorschemetoggle = false
 
-  customCSS = ["css/custom.css"]
-  customSCSS = ["scss/custom.scss"]
-  customJS = ["js/custom.js"]
+  # customCSS = ["css/custom.css"]
+  # customSCSS = ["scss/custom.scss"]
+  # customJS = ["js/custom.js"]
 
 [taxonomies]
   category = "categories"