Skip to content

Commit

Permalink
Namespace functions and methods
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring authored Nov 5, 2023
1 parent 4021277 commit 723a827
Show file tree
Hide file tree
Showing 687 changed files with 20,493 additions and 5,865 deletions.
5 changes: 3 additions & 2 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@
"مدونتي"
],
"language": "en,en-US,de,fr",
"allowCompoundWords": true,
"allowCompoundWords": false,
"files": [
"**/*.md"
],
Expand All @@ -354,7 +354,8 @@
"**/node_modules/**",
"*.min.*",
"**/news/*",
"**/showcase/*"
"**/showcase/*",
"**/content-management/emoji-shortcodes.md"
],
"useGitignore": true,
"enabled": true
Expand Down
393 changes: 200 additions & 193 deletions LICENSE.md

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,11 @@ Spelling fixes are most welcomed, and if you want to contribute longer sections
* For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. Don't list long and similar examples just so people can use them on their sites.
* Hugo has users from all over the world, so easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.


## Edit the theme

If you want to do docs-related theme changes, the simplest way is to have both `hugoDocs` and `gohugoioTheme` cloned as sibling directories, and then run:

```
```sh
HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
```

Expand All @@ -37,15 +36,15 @@ HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"

To view the documentation site locally, you need to clone this repository:

```bash
```sh
git clone https://github.com/gohugoio/hugoDocs.git
```

Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).

Then to view the docs in your browser, run Hugo and open up the link:

```bash
```sh
▶ hugo server

Started building sites ...
Expand Down
9 changes: 3 additions & 6 deletions archetypes/functions.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
title: {{ replace .File.ContentBaseName "-" " " | title }}
description:
categories: [functions]
categories: []
keywords: []
menu:
docs:
parent: functions
function:
action:
aliases: []
related: []
returnType:
signatures: []
relatedFunctions: []
---
10 changes: 10 additions & 0 deletions archetypes/methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: {{ replace .File.ContentBaseName "-" " " | title }}
description:
categories: []
keywords: []
action:
related: []
returnType:
signatures: []
---
5 changes: 2 additions & 3 deletions archetypes/showcase/bio.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ Add some **general info** about {{ replace .Name "-" " " | title }} here.

The site is built by:

* [Person 1](https://example.com)
* [Person 1](https://example.com)

* [Person 1](https://example.org)
* [Person 1](https://example.org)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/examples/zion-national-park.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/logo-128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/logo-256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/logo-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/logo-64x64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logos/logo-96x96.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
194 changes: 102 additions & 92 deletions config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
@@ -1,142 +1,152 @@
[[docs]]
name = "About Hugo"
weight = 10
identifier = "about"
url = "/about/"
identifier = 'about'
name = 'About Hugo'
pageRef = '/about/'
weight = 10

[[docs]]
name = "Installation"
weight = 20
identifier = "installation"
url = "/installation/"
name = 'Installation'
weight = 20
identifier = 'installation'
pageRef = '/installation/'

[[docs]]
name = "Getting started"
weight = 30
identifier = "getting-started"
url = "/getting-started/"
name = 'Getting started'
weight = 30
identifier = 'getting-started'
pageRef = '/getting-started/'

[[docs]]
name = "Hugo Modules"
weight = 40
identifier = "modules"
post = "break"
url = "/hugo-modules/"
name = 'Hugo Modules'
weight = 40
identifier = 'modules'
post = 'break'
pageRef = '/hugo-modules/'

# Core menus
[[docs]]
name = 'Content management'
weight = 50
identifier = 'content-management'
post = 'expanded'
pageRef = '/content-management/'

[[docs]]
name = 'Templates'
weight = 60
identifier = 'templates'
pageRef = '/templates/'

[[docs]]
name = "Content management"
weight = 50
identifier = "content-management"
post = "expanded"
url = "/content-management/"
name = 'Functions'
weight = 70
identifier = 'functions'
pageRef = '/functions/'

[[docs]]
name = "Templates"
weight = 60
identifier = "templates"
url = "/templates/"
name = 'Methods'
weight = 80
identifier = 'methods'
pageRef = '/methods/'

[[docs]]
name = "Functions"
weight = 70
identifier = "functions"
url = "/functions/"
name = 'Quick reference'
weight = 90
identifier = 'quick-reference'
pageRef = '/quick-reference/'

[[docs]]
name = "Variables"
weight = 80
identifier = "variables"
url = "/variables/"
name = 'Variables'
weight = 95
identifier = 'variables'
pageRef = '/variables/'

[[docs]]
name = "Hugo Pipes"
weight = 90
identifier = "hugo-pipes"
url = "/hugo-pipes/"
name = 'Hugo Pipes'
weight = 100
identifier = 'hugo-pipes'
pageRef = '/hugo-pipes/'

[[docs]]
name = "CLI"
weight = 100
post = "break"
identifier = "commands"
url = "/commands/"
name = 'CLI'
weight = 110
post = 'break'
identifier = 'commands'
pageRef = '/commands/'

# Low level items

[[docs]]
name = "Troubleshooting"
weight = 110
identifier = "troubleshooting"
url = "/troubleshooting/"
name = 'Troubleshooting'
weight = 120
identifier = 'troubleshooting'
pageRef = '/troubleshooting/'

[[docs]]
name = "Developer tools"
weight = 120
identifier = "developer-tools"
url = "/tools/"
name = 'Developer tools'
weight = 130
identifier = 'developer-tools'
pageRef = '/tools/'

[[docs]]
name = "Hosting and deployment"
weight = 130
identifier = "hosting-and-deployment"
url = "/hosting-and-deployment/"
name = 'Hosting and deployment'
weight = 140
identifier = 'hosting-and-deployment'
pageRef = '/hosting-and-deployment/'

[[docs]]
name = "Contribute"
weight = 140
post = "break"
identifier = "contribute"
url = "/contribute/"
name = 'Contribute'
weight = 150
post = 'break'
identifier = 'contribute'
pageRef = '/contribute/'

######## QUICKLINKS

Check warning on line 103 in config/_default/menus/menus.en.toml

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (QUICKLINKS)

[[quicklinks]]

Check warning on line 105 in config/_default/menus/menus.en.toml

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (quicklinks)
name = "Fundamentals"
weight = 1
identifier = "fundamentals"
url = "/tags/fundamentals/"
identifier = 'fundamentals'
name = 'Fundamentals'
pageRef = '/tags/fundamentals/'
weight = 1

######## GLOBAL ITEMS TO BE SHARED WITH THE HUGO SITES

[[global]]
name = "News"
weight = 1
identifier = "news"
url = "/news/"
name = 'News'
weight = 1
identifier = 'news'
pageRef = '/news/'

[[global]]
name = "Docs"
weight = 5
identifier = "docs"
url = "/documentation/"
name = 'Docs'
weight = 5
identifier = 'docs'
url = '/documentation/'

[[global]]
name = "Themes"
weight = 10
identifier = "themes"
url = "https://themes.gohugo.io/"
name = 'Themes'
weight = 10
identifier = 'themes'
url = 'https://themes.gohugo.io/'

[[global]]
name = "Showcase"
weight = 20
identifier = "showcase"
url = "/showcase/"
name = 'Showcase'
weight = 20
identifier = 'showcase'
pageRef = '/showcase/'

# Anything with a weight > 100 gets an external icon

[[global]]
name = "Community"
weight = 150
icon = true
identifier = "community"
post = "external"
url = "https://discourse.gohugo.io/"
name = 'Community'
weight = 150
icon = true
identifier = 'community'
post = 'external'
url = 'https://discourse.gohugo.io/'

[[global]]
name = "GitHub"
weight = 200
identifier = "github"
post = "external"
url = "https://github.com/gohugoio/hugo"
name = 'GitHub'
weight = 200
identifier = 'github'
post = 'external'
url = 'https://github.com/gohugoio/hugo'
3 changes: 3 additions & 0 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ flex_box_interior_classes = "flex-auto w-100 w-40-l mr3 mb3 bg-white ba b--moon-

[social]
twitter = "GoHugoIO"

[render_hooks.link]
errorLevel = 'warning' # ignore (default), warning, or error (fails the build)
8 changes: 4 additions & 4 deletions content/en/about/hugo-and-gdpr.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ toc: true

Below are all privacy settings and their default value. These settings need to be put in your site configuration (e.g. `hugo.toml`).

{{< code-toggle file="hugo" >}}
{{< code-toggle file=hugo >}}
[privacy]
[privacy.disqus]
disable = false
Expand Down Expand Up @@ -58,7 +58,7 @@ privacyEnhanced = false

An example privacy configuration that disables all the relevant services in Hugo. With this configuration, the other settings will not matter.

{{< code-toggle file="hugo" >}}
{{< code-toggle file=hugo >}}
[privacy]
[privacy.disqus]
disable = true
Expand Down Expand Up @@ -98,7 +98,7 @@ simple

**Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inline styles provided by Hugo:

{{< code-toggle file="hugo" >}}
{{< code-toggle file=hugo >}}
[services]
[services.instagram]
disableInlineCSS = true
Expand All @@ -114,7 +114,7 @@ simple

**Note:** If you use the _simple mode_ for Twitter, you may want to disable the inline styles provided by Hugo:

{{< code-toggle file="hugo" >}}
{{< code-toggle file=hugo >}}
[services]
[services.twitter]
disableInlineCSS = true
Expand Down
Loading

0 comments on commit 723a827

Please sign in to comment.