diff options
author | Christian Oliff <christianoliff@pm.me> | 2022-11-10 09:17:05 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-10 09:17:05 +0300 |
commit | d333d0287c78c55a7ae7acec1b26416abe2fde62 (patch) | |
tree | 16ea918c14ba314ef39f76949e50bf47a1251aa0 | |
parent | d57c8aa505981558c910fd154691aab8519fd71c (diff) |
Minor markdown linting fix and URL updates (#1873)
-rw-r--r-- | .github/workflows/codeql-analysis.yml | 16 | ||||
-rw-r--r-- | .github/workflows/spellcheck.yml | 2 | ||||
-rw-r--r-- | .github/workflows/super-linter.yml | 6 | ||||
-rw-r--r-- | .markdownlint.yaml | 1 | ||||
-rw-r--r-- | content/en/about/features.md | 2 | ||||
-rw-r--r-- | content/en/about/security-model/index.md | 2 | ||||
-rw-r--r-- | content/en/about/what-is-hugo.md | 2 | ||||
-rw-r--r-- | content/en/content-management/urls.md | 2 | ||||
-rw-r--r-- | content/en/contribute/development.md | 6 | ||||
-rw-r--r-- | content/en/functions/errorf.md | 2 | ||||
-rw-r--r-- | content/en/hugo-modules/_index.md | 2 | ||||
-rw-r--r-- | content/en/templates/data-templates.md | 4 | ||||
-rw-r--r-- | content/en/templates/template-debugging.md | 2 | ||||
-rw-r--r-- | content/en/variables/page.md | 2 |
14 files changed, 24 insertions, 27 deletions
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 841383c96..30f98a000 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -14,13 +14,13 @@ jobs: security-events: write steps: - - name: Checkout repository - uses: actions/checkout@v3 + - name: Checkout repository + uses: actions/checkout@v3 - - name: Initialize CodeQL - uses: github/codeql-action/init@v2 - with: - languages: 'javascript' + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: "javascript" - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index b90689862..594621604 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -1,4 +1,4 @@ -name: 'Check spelling' +name: "Check spelling" on: # rebuild any PRs and main branch changes push: branches-ignore: diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml index ad756d892..efd206960 100644 --- a/.github/workflows/super-linter.yml +++ b/.github/workflows/super-linter.yml @@ -4,13 +4,13 @@ on: workflow_dispatch: permissions: - contents: read # to fetch code (actions/checkout) + contents: read # to fetch code (actions/checkout) jobs: build: permissions: - contents: read # to fetch code (actions/checkout) - statuses: write # to mark status of each linter run (github/super-linter/slim) + contents: read # to fetch code (actions/checkout) + statuses: write # to mark status of each linter run (github/super-linter/slim) name: Lint Code Base runs-on: ubuntu-latest diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 3f4cf44c7..58f84dc67 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -10,7 +10,6 @@ MD013: false MD014: false MD022: false MD024: false -MD026: false MD031: false MD032: false MD033: false diff --git a/content/en/about/features.md b/content/en/about/features.md index 28a5099a9..6c443ef05 100644 --- a/content/en/about/features.md +++ b/content/en/about/features.md @@ -63,7 +63,7 @@ toc: true [Extremely fast]: https://github.com/bep/hugo-benchmark [front matter]: /content-management/front-matter/ [functions]: /functions/ -[Go]: https://golang.org/pkg/html/template/ +[Go]: https://pkg.go.dev/html/template [Google Analytics]: https://google-analytics.com/ [homepage]: /templates/homepage/ [hostanywhere]: /hosting-and-deployment/ diff --git a/content/en/about/security-model/index.md b/content/en/about/security-model/index.md index c46c57eae..d3a713012 100644 --- a/content/en/about/security-model/index.md +++ b/content/en/about/security-model/index.md @@ -55,7 +55,7 @@ These are the security threats as defined by [OWASP](https://en.wikipedia.org/wi For HTML output, this is the core security model: -<https://golang.org/pkg/html/template/#hdr-Security_Model> +<https://pkg.go.dev/html/template#hdr-Security_Model> In short: diff --git a/content/en/about/what-is-hugo.md b/content/en/about/what-is-hugo.md index 69ca1fddb..01fac90c8 100644 --- a/content/en/about/what-is-hugo.md +++ b/content/en/about/what-is-hugo.md @@ -47,7 +47,7 @@ Hugo is for people building a blog, a company site, a portfolio site, documentat [Firebase]: https://firebase.google.com/docs/hosting/ "Firebase static hosting" [GitHub Pages]: https://pages.github.com/ [GitLab Pages]: https://about.gitlab.com/features/pages/ -[Go language]: https://golang.org/ +[Go language]: https://go.dev/ [GoDaddy]: https://www.godaddy.com/ "GoDaddy.com Hosting" [Google Cloud Storage]: https://cloud.google.com/storage/ [Heroku]: https://www.heroku.com/ diff --git a/content/en/content-management/urls.md b/content/en/content-management/urls.md index 6a4081535..2391e8c64 100644 --- a/content/en/content-management/urls.md +++ b/content/en/content-management/urls.md @@ -43,7 +43,7 @@ permalinks: /: /:year/:month/:filename/ {{< /code-toggle >}} -If the standard date-based permalink configuration does not meet your needs, you can also format URL segments using [Go time formatting directives](https://golang.org/pkg/time/#Time.Format). For example, a URL structure with two digit years and month and day digits without zero padding can be accomplished with: +If the standard date-based permalink configuration does not meet your needs, you can also format URL segments using [Go time formatting directives](https://pkg.go.dev/time#Time.Format). For example, a URL structure with two digit years and month and day digits without zero padding can be accomplished with: {{< code-toggle file="config" copy="false" >}} permalinks: diff --git a/content/en/contribute/development.md b/content/en/contribute/development.md index a9d06343a..dfdf60ddb 100644 --- a/content/en/contribute/development.md +++ b/content/en/contribute/development.md @@ -422,11 +422,11 @@ Feel free to [open an issue][newissue] if you think you found a bug or you have [forums]: https://discourse.gohugo.io [gitbook]: https://git-scm.com/ [gobootcamp]: https://www.golangbootcamp.com/book/get_setup -[godl]: https://golang.org/dl/ -[goinstall]: https://golang.org/doc/install +[godl]: https://go.dev/dl/ +[goinstall]: https://go.dev/doc/install [gvm]: https://github.com/moovweb/gvm [issues]: https://github.com/gohugoio/hugo/issues [newissue]: https://github.com/gohugoio/hugo/issues/new [releases]: /getting-started/ -[setupgopath]: https://golang.org/doc/code.html#Workspaces +[setupgopath]: https://go.dev/doc/code#Workspaces [trygit]: https://try.github.io/levels/1/challenges/1 diff --git a/content/en/functions/errorf.md b/content/en/functions/errorf.md index 41ea2f192..04fd0edb0 100644 --- a/content/en/functions/errorf.md +++ b/content/en/functions/errorf.md @@ -30,7 +30,7 @@ Both functions return an empty string, so the messages are only printed to the c {{ warnf "You should update the shortcodes in %q" .Path }} ``` -Note that `errorf`, `erroridf`, and `warnf` support all the formatting verbs of the [fmt](https://golang.org/pkg/fmt/) package. +Note that `errorf`, `erroridf`, and `warnf` support all the formatting verbs of the [fmt](https://pkg.go.dev/fmt) package. ## Suppress errors diff --git a/content/en/hugo-modules/_index.md b/content/en/hugo-modules/_index.md index 2b02a559e..b2951da9a 100644 --- a/content/en/hugo-modules/_index.md +++ b/content/en/hugo-modules/_index.md @@ -24,7 +24,7 @@ You can combine modules in any combination you like, and even mount directories Hugo Modules are powered by Go Modules. For more information about Go Modules, see: - [https://github.com/golang/go/wiki/Modules](https://github.com/golang/go/wiki/Modules) -- [https://blog.golang.org/using-go-modules](https://blog.golang.org/using-go-modules) +- [https://go.dev/blog/using-go-modules](https://go.dev/blog/using-go-modules) This is all very much brand new and there are only a few example projects around: diff --git a/content/en/templates/data-templates.md b/content/en/templates/data-templates.md index 5ea574457..e560aba11 100644 --- a/content/en/templates/data-templates.md +++ b/content/en/templates/data-templates.md @@ -4,7 +4,6 @@ linktitle: description: In addition to Hugo's built-in variables, you can specify your own custom data in templates or shortcodes that pull from both local and dynamic sources. date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-03-12 categories: [templates] keywords: [data,dynamic,csv,json,toml,yaml,xml] menu: @@ -13,7 +12,6 @@ menu: weight: 80 weight: 80 sections_weight: 80 -draft: false aliases: [/extras/datafiles/,/extras/datadrivencontent/,/doc/datafiles/] toc: true --- @@ -28,7 +26,7 @@ Hugo supports loading data from YAML, JSON, XML, and TOML files located in the ` The `data` folder is where you can store additional data for Hugo to use when generating your site. Data files aren't used to generate standalone pages; rather, they're meant to be supplemental to content files. This feature can extend the content in case your front matter fields grow out of control. Or perhaps you want to show a larger dataset in a template (see example below). In both cases, it's a good idea to outsource the data in their own files. -These files must be YAML, JSON, XML, or TOML files (using the `.yml`, `.yaml`, `.json`, `.xml`, or `.toml` extension). The data will be accessible as a `map` in the `.Site.Data` variable. +These files must be YAML, JSON, XML, or TOML files (using the `.yml`, `.yaml`, `.json`, `.xml`, or `.toml` extension). The data will be accessible as a `map` in the `.Site.Data` variable. If you wish to access the data using the `.Site.Data.filename` notation, the filename must begin with an underscore or a Unicode letter, followed by zero or more underscores, Unicode letters, or Unicode digits. eg: diff --git a/content/en/templates/template-debugging.md b/content/en/templates/template-debugging.md index 8992c432d..ef8e205da 100644 --- a/content/en/templates/template-debugging.md +++ b/content/en/templates/template-debugging.md @@ -17,7 +17,7 @@ toc: false Here are some snippets you can add to your template to answer some common questions. -These snippets use the `printf` function available in all Go templates. This function is an alias to the Go function, [fmt.Printf](https://golang.org/pkg/fmt/). +These snippets use the `printf` function available in all Go templates. This function is an alias to the Go function, [fmt.Printf](https://pkg.go.dev/fmt). ## What Variables are Available in this Context? diff --git a/content/en/variables/page.md b/content/en/variables/page.md index 26249e61d..d1def9281 100644 --- a/content/en/variables/page.md +++ b/content/en/variables/page.md @@ -114,7 +114,7 @@ See also `.ExpiryDate`, `.Date`, `.PublishDate`, and [`.GitInfo`][gitinfo]. : the Page content stripped of HTML tags and presented as a string. .PlainWords -: the slice of strings that results from splitting .Plain into words, as defined in Go's [strings.Fields](https://golang.org/pkg/strings/#Fields). +: the slice of strings that results from splitting .Plain into words, as defined in Go's [strings.Fields](https://pkg.go.dev/strings#Fields). .Prev : Points down to the previous [regular page](/variables/site/#site-pages) (sorted by Hugo's [default sort](/templates/lists#default-weight--date--linktitle--filepath)). Example: `{{if .Prev}}{{.Prev.Permalink}}{{end}}`. Calling `.Prev` from the last page returns `nil`. |