diff --git a/.gitignore b/.gitignore index 3e046d8bc..7dd86da71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,7 @@ pipeline/node_modules ryans-notes.md themes/hugo-docs-concept/pipeline/node_modules +public .DS_Store + +.netlify diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..02ee5dd4e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "themes/gohugo-theme"] + path = themes/gohugo-theme + url = https://github.com/budparr/gohugo-theme.git diff --git a/config.toml b/config.toml index 92a503965..56bbb7429 100644 --- a/config.toml +++ b/config.toml @@ -2,6 +2,8 @@ baseurl = "https://hugodocs.info" canonifyurls = true # Pointing to this file config = "config.toml" +enableGitInfo = true +paginate= 100 copyright = "" defaultContentLanguage = "en" # Set to true to keep url path preserve casing (eg, for sections) @@ -28,8 +30,10 @@ relativeURLs = true stepAnalysis = true # This is the top-level, global site title title = "Hugo" -# Change this to your preferred theme -theme = "hugo-docs-concept" + +# Change this once you've created your theme +theme = "gohugo-theme" + # Set to true to convert mysite/section/ to mysite/section.html uglyURLs = false verbose = false @@ -56,7 +60,7 @@ googleAnalytics = "UA-76549364-1" ## Gh repo for site footer (include trailing slash) ghrepo = "https://github.com/spf13/hugo/" ### Edit content repo (set to automatically enter "edit" mode; this is good for "improve this page" links) - ghdocsrepo = "https://github.com/rdwatters/hugo-docs-concept/tree/master" + ghdocsrepo = "https://github.com/spf13/hugo/tree/master/docs" ## Gitter URL gitter = "https://gitter.im/spf13/hugo" ## Discuss Forum URL @@ -64,6 +68,8 @@ googleAnalytics = "UA-76549364-1" ## Google Tag Manager gtmid = "" + #sidebar_direction = "sidebar_left" + # MARKDOWN ## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday [blackfriday] @@ -75,3 +81,160 @@ googleAnalytics = "UA-76549364-1" ## As of v0.20, all content files include a default "categories" value that's the same as the section. This was a cheap future-proofing method and should/could be changed accordingly. [taxonomies] tag = "tags" + category = "categories" + + +# High level items + +[[menu.docs]] + name = "About Hugo" + weight = 1 + identifier = "about" + url = "/about/" + +[[menu.docs]] + name = "Getting Started" + weight = 5 + identifier = "getting-started" + url = "/getting-started/" + + +[[menu.docs]] + name = "Themes" + weight = 15 + identifier = "themes" + post = "break" + url = "/themes/" + +# Core Menus + +[[menu.docs]] + name = "Content Management" + weight = 20 + identifier = "content-management" + post = "expanded" + url = "/content-management/" + +[[menu.docs]] + name = "Templates" + weight = 25 + identifier = "templates" + + url = "/templates/" + +[[menu.docs]] + name = "Functions" + weight = 30 + identifier = "functions" + url = "/functions/" + +[[menu.docs]] + name = "Variables" + weight = 35 + identifier = "variables" + url = "/variables/" + +[[menu.docs]] + name = "CLI" + weight = 40 + post = "break" + identifier = "commands" + url = "/commands/" + + + +# LOW LEVEL ITEMS + + +[[menu.docs]] + name = "Troubleshooting" + weight = 60 + identifier = "troubleshooting" + url = "/troubleshooting/" + +[[menu.docs]] + name = "Tools" + weight = 70 + identifier = "tools" + url = "/tools/" + +[[menu.docs]] + name = "Hosting & Deployment" + weight = 80 + identifier = "hosting-and-deployment" + url = "/hosting-and-deployment/" + +# [[menu.docs]] +# name = "Showcase" +# weight = 90 +# identifier = "showcase" +# url = "/showcase/" +# + +[[menu.docs]] + name = "Contribute" + weight = 100 + post = "break" + identifier = "contribute" + url = "/contribute/" + +[[menu.docs]] + name = "Tags" + weight = 120 + identifier = "tags" + url = "/tags/" + + +# [[menu.docs]] +# name = "Categories" +# weight = 140 +# identifier = "categories" +# url = "/categories/" + +######## QUICKLINKS + + [[menu.quicklinks]] + name = "Fundamentals" + weight = 1 + identifier = "fundamentals" + url = "/tags/fundamentals/" + + + + +######## GLOBAL ITEMS TO BE SHARED WITH THE HUGO siteaddress + +[[menu.global]] + name = "News" + weight = 1 + identifier = "news" + url = "https://hugodocs.info/news/" + + [[menu.global]] + name = "Docs" + weight = 5 + identifier = "docs" + url = "/" + + [[menu.global]] + name = "Themes" + weight = 10 + identifier = "themes" + url = "http://themes.gohugo.io/" + + # Anything with a weight > 100 gets an external icon + [[menu.global]] + name = "Community" + weight = 150 + icon = true + identifier = "community" + post = "external" + url = "https://discuss.gohugo.io/" + + + [[menu.global]] + name = "Github" + weight = 200 + identifier = "github" + post = "external" + url = "https://github.com/spf13/hugo" diff --git a/content/_index.md b/content/_index.md index 7bb7d36b1..607f55f43 100644 --- a/content/_index.md +++ b/content/_index.md @@ -15,3 +15,4 @@ slug: aliases: [] toc: false --- +Hugo is the world's fastest static website engine. It's written in Golang and developed by spf13 and friends. Below you will find some of the most common and helpful pages from our documentation. diff --git a/content/about/_index.md b/content/about/_index.md index 3fd4e3759..843882be4 100644 --- a/content/about/_index.md +++ b/content/about/_index.md @@ -1,6 +1,5 @@ --- title: About Hugo -linktitle: Overview description: Hugo's features, roadmap, license, and motivation. date: 2017-02-01 publishdate: 2017-02-01 @@ -8,13 +7,13 @@ lastmod: 2017-02-01 categories: [] tags: [] menu: - main: - parent: "About Hugo" - weight: 01 -weight: 01 #rem + docs: + parent: "about" + weight: 1 +weight: 1 draft: false aliases: [/about-hugo/,/docs/] toc: false --- -Hugo is not your average static site generator. \ No newline at end of file +Hugo is not your average static site generator. diff --git a/content/about/benefits.md b/content/about/benefits.md index 3829c9682..13f78208e 100644 --- a/content/about/benefits.md +++ b/content/about/benefits.md @@ -7,8 +7,8 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [ssg,static,performance,security] menu: - main: - parent: "About Hugo" + docs: + parent: "about" weight: 30 weight: 30 sections_weight: 30 diff --git a/content/about/features.md b/content/about/features.md index 917c6885d..f9a004e06 100644 --- a/content/about/features.md +++ b/content/about/features.md @@ -6,8 +6,8 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 menu: - main: - parent: "About Hugo" + docs: + parent: "about" weight: 20 weight: 20 sections_weight: 20 @@ -87,4 +87,4 @@ See what's coming next in the [Hugo roadmap][]. [Syntax highlighting]: /tools/syntax-highlighting/ [table of contents]: /content-management/toc/ [taxonomies]: /content-management/taxonomies/ -[URLs]: /content-management/urls/ \ No newline at end of file +[URLs]: /content-management/urls/ diff --git a/content/about/license.md b/content/about/license.md index 43d04913d..c1c854f6b 100644 --- a/content/about/license.md +++ b/content/about/license.md @@ -8,8 +8,8 @@ lastmod: 2016-03-02 categories: ["about hugo"] tags: ["License","apache"] menu: - main: - parent: "About Hugo" + docs: + parent: "about" weight: 60 weight: 60 sections_weight: 60 diff --git a/content/about/roadmap.md b/content/about/roadmap.md index 6a7cf22ca..f2f5c6627 100644 --- a/content/about/roadmap.md +++ b/content/about/roadmap.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [about hugo] tags: [about,contribute,roadmap] menu: - main: - parent: "About Hugo" + docs: + parent: "about" weight: 50 weight: 50 sections_weight: 50 @@ -48,4 +48,4 @@ Feel free to [contribute to Hugo's development][devcontribute], [improve Hugo's [themes]: /themes/ [themescontrib]: /contribute/themes/ [tutorials]: /tutorials -[***your*** best ideas!]: /contribute/ \ No newline at end of file +[***your*** best ideas!]: /contribute/ diff --git a/content/about/what-is-hugo.md b/content/about/what-is-hugo.md index 222ae1a80..f6055de3e 100644 --- a/content/about/what-is-hugo.md +++ b/content/about/what-is-hugo.md @@ -77,4 +77,4 @@ I wanted to develop a fast and full-featured website framework without any depen [static site generator]: /about/benefits/ [Rackspace]: https://www.rackspace.com/cloud/files [static site generator]: /about/benefits/ -[Surge]: https://surge.sh \ No newline at end of file +[Surge]: https://surge.sh diff --git a/content/commands/_index.md b/content/commands/_index.md index a476d3b36..c454ef2c4 100644 --- a/content/commands/_index.md +++ b/content/commands/_index.md @@ -1,6 +1,6 @@ --- title: Command Line Reference -linktitle: Command Line Reference +linktitle: CLI description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. date: 2017-02-01 publishdate: 2017-02-01 @@ -8,9 +8,9 @@ lastmod: 2017-02-01 categories: [commands] tags: [cli,command line] menu: - main: - parent: "Commands" - weight: 01 + docs: + parent: "commands" + weight: 1 weight: 01 #rem draft: false aliases: [/cli/] diff --git a/content/commands/hugo.md b/content/commands/hugo.md index 1891f3e71..dba99db3e 100644 --- a/content/commands/hugo.md +++ b/content/commands/hugo.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo" +menu: + docs: + parent: "commands" slug: hugo url: /commands/hugo/ --- diff --git a/content/commands/hugo_benchmark.md b/content/commands/hugo_benchmark.md index 4001b1b02..a46489a1e 100644 --- a/content/commands/hugo_benchmark.md +++ b/content/commands/hugo_benchmark.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo benchmark" +menu: + docs: + parent: "commands" slug: hugo_benchmark url: /commands/hugo_benchmark/ --- diff --git a/content/commands/hugo_check.md b/content/commands/hugo_check.md index 22eeb0f1b..b17d6b9cf 100644 --- a/content/commands/hugo_check.md +++ b/content/commands/hugo_check.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo check" +menu: + docs: + parent: "commands" slug: hugo_check url: /commands/hugo_check/ --- diff --git a/content/commands/hugo_check_ulimit.md b/content/commands/hugo_check_ulimit.md index 88b457c8d..5f2ba1f6f 100644 --- a/content/commands/hugo_check_ulimit.md +++ b/content/commands/hugo_check_ulimit.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo check ulimit" +menu: + docs: + parent: "commands" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ --- diff --git a/content/commands/hugo_config.md b/content/commands/hugo_config.md index ff1975e2e..67df49119 100644 --- a/content/commands/hugo_config.md +++ b/content/commands/hugo_config.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo config" +menu: + docs: + parent: "commands" slug: hugo_config url: /commands/hugo_config/ --- diff --git a/content/commands/hugo_convert.md b/content/commands/hugo_convert.md index e29f6f4d4..6172189cf 100644 --- a/content/commands/hugo_convert.md +++ b/content/commands/hugo_convert.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo convert" +menu: + docs: + parent: "commands" slug: hugo_convert url: /commands/hugo_convert/ --- diff --git a/content/commands/hugo_convert_toJSON.md b/content/commands/hugo_convert_toJSON.md index 4ba3b493b..ddd217619 100644 --- a/content/commands/hugo_convert_toJSON.md +++ b/content/commands/hugo_convert_toJSON.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo convert toJSON" +menu: + docs: + parent: "commands" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ --- diff --git a/content/commands/hugo_convert_toTOML.md b/content/commands/hugo_convert_toTOML.md index 0d4d19cea..9a7e32c47 100644 --- a/content/commands/hugo_convert_toTOML.md +++ b/content/commands/hugo_convert_toTOML.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo convert toTOML" +menu: + docs: + parent: "commands" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ --- diff --git a/content/commands/hugo_convert_toYAML.md b/content/commands/hugo_convert_toYAML.md index 3fc8ccce2..f9698151d 100644 --- a/content/commands/hugo_convert_toYAML.md +++ b/content/commands/hugo_convert_toYAML.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo convert toYAML" +menu: + docs: + parent: "commands" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ --- diff --git a/content/commands/hugo_env.md b/content/commands/hugo_env.md index 6232e1f9a..c5947a65b 100644 --- a/content/commands/hugo_env.md +++ b/content/commands/hugo_env.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo env" +menu: + docs: + parent: "commands" slug: hugo_env url: /commands/hugo_env/ --- diff --git a/content/commands/hugo_gen.md b/content/commands/hugo_gen.md index a03b577dc..ebab309e8 100644 --- a/content/commands/hugo_gen.md +++ b/content/commands/hugo_gen.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo gen" +menu: + docs: + parent: "commands" slug: hugo_gen url: /commands/hugo_gen/ --- diff --git a/content/commands/hugo_gen_autocomplete.md b/content/commands/hugo_gen_autocomplete.md index bcde2c3aa..015dbd03e 100644 --- a/content/commands/hugo_gen_autocomplete.md +++ b/content/commands/hugo_gen_autocomplete.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo gen autocomplete" +menu: + docs: + parent: "commands" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ --- diff --git a/content/commands/hugo_gen_doc.md b/content/commands/hugo_gen_doc.md index 0aa53274b..43d6183ea 100644 --- a/content/commands/hugo_gen_doc.md +++ b/content/commands/hugo_gen_doc.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo gen doc" +menu: + docs: + parent: "commands" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ --- diff --git a/content/commands/hugo_gen_man.md b/content/commands/hugo_gen_man.md index f0543ecf1..f77d00562 100644 --- a/content/commands/hugo_gen_man.md +++ b/content/commands/hugo_gen_man.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo gen man" +menu: + docs: + parent: "commands" slug: hugo_gen_man url: /commands/hugo_gen_man/ --- diff --git a/content/commands/hugo_import.md b/content/commands/hugo_import.md index f344e69c6..18618cc61 100644 --- a/content/commands/hugo_import.md +++ b/content/commands/hugo_import.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo import" +menu: + docs: + parent: "commands" slug: hugo_import url: /commands/hugo_import/ --- diff --git a/content/commands/hugo_import_jekyll.md b/content/commands/hugo_import_jekyll.md index e3c1b29f6..d1cb5c49f 100644 --- a/content/commands/hugo_import_jekyll.md +++ b/content/commands/hugo_import_jekyll.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo import jekyll" +menu: + docs: + parent: "commands" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ --- diff --git a/content/commands/hugo_list.md b/content/commands/hugo_list.md index 9c728bf9d..63ad5f4f9 100644 --- a/content/commands/hugo_list.md +++ b/content/commands/hugo_list.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo list" +menu: + docs: + parent: "commands" slug: hugo_list url: /commands/hugo_list/ --- diff --git a/content/commands/hugo_list_drafts.md b/content/commands/hugo_list_drafts.md index e9c796934..1010b2ada 100644 --- a/content/commands/hugo_list_drafts.md +++ b/content/commands/hugo_list_drafts.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo list drafts" +menu: + docs: + parent: "commands" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ --- diff --git a/content/commands/hugo_list_expired.md b/content/commands/hugo_list_expired.md index 392702c65..ec493ace9 100644 --- a/content/commands/hugo_list_expired.md +++ b/content/commands/hugo_list_expired.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo list expired" +menu: + docs: + parent: "commands" slug: hugo_list_expired url: /commands/hugo_list_expired/ --- diff --git a/content/commands/hugo_list_future.md b/content/commands/hugo_list_future.md index 7858e5441..4f8460182 100644 --- a/content/commands/hugo_list_future.md +++ b/content/commands/hugo_list_future.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo list future" +menu: + docs: + parent: "commands" slug: hugo_list_future url: /commands/hugo_list_future/ --- diff --git a/content/commands/hugo_new.md b/content/commands/hugo_new.md index 47da4fbeb..1a98dbc45 100644 --- a/content/commands/hugo_new.md +++ b/content/commands/hugo_new.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo new" +menu: + docs: + parent: "commands" slug: hugo_new url: /commands/hugo_new/ --- diff --git a/content/commands/hugo_new_site.md b/content/commands/hugo_new_site.md index c60bb8af3..cea69c8ae 100644 --- a/content/commands/hugo_new_site.md +++ b/content/commands/hugo_new_site.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo new site" +menu: + docs: + parent: "commands" slug: hugo_new_site url: /commands/hugo_new_site/ --- diff --git a/content/commands/hugo_new_theme.md b/content/commands/hugo_new_theme.md index 12ebee920..41a014118 100644 --- a/content/commands/hugo_new_theme.md +++ b/content/commands/hugo_new_theme.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo new theme" +menu: + docs: + parent: "commands" slug: hugo_new_theme url: /commands/hugo_new_theme/ --- diff --git a/content/commands/hugo_server.md b/content/commands/hugo_server.md index fabf7a00a..a243a7d24 100644 --- a/content/commands/hugo_server.md +++ b/content/commands/hugo_server.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo server" +menu: + docs: + parent: "commands" slug: hugo_server url: /commands/hugo_server/ --- diff --git a/content/commands/hugo_undraft.md b/content/commands/hugo_undraft.md index 89370937b..1cdf93f69 100644 --- a/content/commands/hugo_undraft.md +++ b/content/commands/hugo_undraft.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo undraft" +menu: + docs: + parent: "commands" slug: hugo_undraft url: /commands/hugo_undraft/ --- diff --git a/content/commands/hugo_version.md b/content/commands/hugo_version.md index 80415bfb0..a2d82f888 100644 --- a/content/commands/hugo_version.md +++ b/content/commands/hugo_version.md @@ -1,6 +1,9 @@ --- date: 2017-02-25T10:01:37+01:00 title: "hugo version" +menu: + docs: + parent: "commands" slug: hugo_version url: /commands/hugo_version/ --- diff --git a/content/content-management/_index.md b/content/content-management/_index.md index 485d5fbb7..812bd0405 100644 --- a/content/content-management/_index.md +++ b/content/content-management/_index.md @@ -1,16 +1,16 @@ --- title: Content Management -linktitle: Overview +linktitle: Content Mgmt. description: Hugo makes managing large static sites easy with support for archetypes, content types, menus, cross references, summaries, and more. date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 +menu: + docs: + parent: "content-management" + weight: 1 tags: [source, organization] categories: [content management] -menu: - main: - parent: "Content Management" - weight: 01 weight: 01 #rem draft: false aliases: [/content/] diff --git a/content/content-management/archetypes.md b/content/content-management/archetypes.md index 22b8e6d42..dce409e28 100644 --- a/content/content-management/archetypes.md +++ b/content/content-management/archetypes.md @@ -8,9 +8,10 @@ lastmod: 2017-02-01 tags: [archetypes,generators,metadata,front matter] categories: ["content management"] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 70 + quicklinks: weight: 70 #rem draft: false aliases: [/content/archetypes/] diff --git a/content/content-management/authors.md b/content/content-management/authors.md index 29fa0f36c..d031ab8d8 100644 --- a/content/content-management/authors.md +++ b/content/content-management/authors.md @@ -8,8 +8,8 @@ lastmod: 2017-03-12 tags: [authors] categories: ["content management"] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 55 weight: 55 #rem draft: true @@ -190,4 +190,4 @@ The example above generates a simple list of all posts written by a single autho With a lot of content this list can quickly become very long. Consider to use the [pagination][] feature. It splits the list into smaller chunks and spreads them over multiple pages. [pagevars]: /variables/page/ -[pagination]: /templates/pagination/ \ No newline at end of file +[pagination]: /templates/pagination/ diff --git a/content/content-management/comments.md b/content/content-management/comments.md index 8ae69b38c..3ac13e6c6 100644 --- a/content/content-management/comments.md +++ b/content/content-management/comments.md @@ -8,8 +8,8 @@ lastmod: 2017-03-09 tags: [sections,content,organization, fundamentals] categories: [project organization] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 140 weight: 140 #rem draft: false diff --git a/content/content-management/cross-references.md b/content/content-management/cross-references.md index 0b5185d46..38ba40102 100644 --- a/content/content-management/cross-references.md +++ b/content/content-management/cross-references.md @@ -8,8 +8,8 @@ lastmod: 2017-03-31 categories: [content management] tags: ["cross references","references", "anchors", "urls"] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 100 weight: 100 #rem draft: false diff --git a/content/content-management/custom-outputs.md b/content/content-management/custom-outputs.md new file mode 100644 index 000000000..41753a577 --- /dev/null +++ b/content/content-management/custom-outputs.md @@ -0,0 +1,147 @@ +--- +title: Custom Outputs +linktitle: Custom Outputs +description: Hugo can output content in multiple formats to make quick work of +date: 2017-03-22 +publishdate: 2017-03-22 +lastmod: 2017-03-22 +categories: [content management] +tags: ["amp","outputs"] +menu: + docs: + parent: "content-management" + weight: 100 + quicklinks: +weight: 100 #rem +draft: false +aliases: [/extras/custom-output-types/] +toc: true +wip: true +--- + +{{% warning %}} +Custom output formats is a major feature being released with v20. The following copy is taken from the original proposal and spec and is therefore far from complete. +{{% /warning %}} + +## Media Type + +We add a media type (also known as MIME type and content type). This is a two-part identifier for file formats and format contents transmitted on the Internet. + +For Hugo's use cases, we use the top-level type name/subtype name + suffix. An example would be `application/json+json`. + +Users can define their own media types by using them in an `Output Format` definition (see below). + +The full set of media types will be registered in Go's `mime` package, so they will be recognised by Hugo's development server. + +## Output Format + +A `Page` in Hugo can be rendered to multiple representations on the file system: All will get an HTML page and some of them will get an RSS page (home page, sections etc.). + +When we now create a more formal definition for these output representations, the built-ins mentioned above will be the standard set that can be extended. + +So an `OutputFormat`: + +``` +OutputFormat: + Name + MediaType + Path + IsPlainText (default false) + Protocol + + # And then some optional options + NoUglyURLs + URI # Turn index.x into somevalue.x (similar to `RSSUri` in Hugo `0.19`) +``` + +So: + +* `Name`: The key. +* `Path` - defaults to "", which is the root. Multiple outputs to the same suffix must be separated with a path, ie. "amp" for AMP output. +* `IsPlainText`: Whether to parse the templates with `text/template` or `html/template`. +* `Protocol`: I.e. `webcal://` for calendar files. Defaults to the `baseURL` protocol. + +## Standard Output Formats + +So, according to the above, the current Hugo will look like this: + +| Name | MediaType | Path | IsPlainText +| -------------:|-------------| -----|-----| +| HTML | text/html+html | "" | false | +| RSS | application/rss+xml | "" | false | + +## Layouts + +The current situation (slightly simplified): + +| Kind | Layouts +| ----------------:|:-------------| +| home | index.html, _default/list.html | +| section | section/SECTION.html, SECTION/list.html, _default/section.html, _default/list.html | +| taxonomy | taxonomy/SINGULAR.html,_default/taxonomy.html, _default/list.html | +| taxonomyTerm |taxonomy/SINGULAR.terms.html, _default/terms.html| +| page | TYPE/LAYOUT.html, _default/LAYOUT.html, _default/single.html| + +The above is what the Output Format `HTML` must resolve to. + +So, let us make up some other Output Formats and see how that will have to look: + +| Name | MediaType | Path | IsPlainText +| -------------:|-------------| -----|-----| +| JSON | application/json+json | "" | true | +| AMP | text/html+html | amp | false | + +Both of the above can be handled if we add both `Name` and the `Suffix` to the mix. Let us use the home page as an example: + +| Type | Layouts +| -----------:|:-------------| +| JSON | index.json.json, index.json, _default/list.json.json, _default/list.json +| AMP | index.amp.html, index.html, _default/list.amp.html, _default/list.html + +* The above adds the lower-case `Name` as a prefix to the lookup path. +* The above also assumes that it makes sense to edit the templates with the same suffix as the end result (.html, .json etc.). + +TODO: RSS, 404 etc. + +## Examples + +`config.toml`: + +``` +# Add some custom output type definitions: +[[outputFormats]] +name = "Calendar" +mediaType = "text/calendar+ics" +protocol = "webcal://" +isPlainText = true + +[[outputFormats]] +name = "JSON" +mediaType = "application/json" # Will get its file suffix from the sub-type, i.e. "json" +isPlainText = true + +[[outputFormats]] +name = "AMP" +mediaType = "text/html" +path = "amp" + +``` + +Note that Hugo well hard code a predefined list of the most common output types (not sure what that would be, suggestions welcome) with the obvious identifiers and sensible defaults: So whenever you want them, you can just say "json, yaml, amp ..." etc. + +Page front matter: + +``` +title = "My Home Page" +outputs = ["html", "rss", "json", "calendar", "amp" ] +``` + +About the `outputs` in the page front matter: + +* If none is provided, it defaults to the current behaviour (i.e. HTML for all pages and RSS for the list pages) +* If some are provided, no defaults will be added. So, if you want the plain HTML representation, you must be explicit. This way you can have the home page as JSON only if you want. +* The names used are case-insensitive and must match either a definition in `config.toml` or the standard set. + +{{% note %}} +It should also be possible to set a list of default output formats in `config.toml`, avoiding the need to repeat the `outputs` list in thousands of pages, with a way to restrict each type to a set of pages (using `Kind`, probably). +{{% /note %}} diff --git a/content/content-management/formats.md b/content/content-management/formats.md index 2b940ba6c..157e9c714 100644 --- a/content/content-management/formats.md +++ b/content/content-management/formats.md @@ -8,8 +8,8 @@ lastmod: 2017-04-06 categories: [content management] tags: [markdown,asciidoc,mmark,content format] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 20 weight: 20 #rem draft: false diff --git a/content/content-management/front-matter.md b/content/content-management/front-matter.md index 812926e80..bc4ccd885 100644 --- a/content/content-management/front-matter.md +++ b/content/content-management/front-matter.md @@ -8,8 +8,8 @@ lastmod: 2017-02-24 categories: [content management] tags: ["front matter", "yaml", "toml", "json", "metadata", "archetypes"] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 30 weight: 30 #rem draft: false diff --git a/content/content-management/menus.md b/content/content-management/menus.md index b6a1105da..7dc44a293 100644 --- a/content/content-management/menus.md +++ b/content/content-management/menus.md @@ -9,8 +9,8 @@ categories: [content management] tags: [menus] draft: false menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 120 weight: 120 #rem aliases: [/extras/menus/] @@ -111,7 +111,7 @@ Take the advanced approach if more control is required. All of the menu entry pr ```yaml --- menu: - main: + docs: parent: 'extras' weight: 20 --- @@ -145,7 +145,7 @@ Here's the equivalent snippet in a `config.yaml`: ```yaml --- menu: - main: + docs: - Name: "about hugo" Pre: "" Weight: -110 diff --git a/content/content-management/multilingual.md b/content/content-management/multilingual.md index c594ecfd6..3870bf947 100644 --- a/content/content-management/multilingual.md +++ b/content/content-management/multilingual.md @@ -8,8 +8,8 @@ lastmod: 2017-01-10 categories: [content management] tags: [multilingual,i18n, internationalization] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 150 weight: 150 #rem draft: false diff --git a/content/content-management/organization.md b/content/content-management/organization.md index 41c5314fc..8c46d63d2 100644 --- a/content/content-management/organization.md +++ b/content/content-management/organization.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [content management] tags: [sections,content,organization,fundamentals] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 10 weight: 10 #rem draft: false diff --git a/content/content-management/sections.md b/content/content-management/sections.md index 6f04024c6..0de95b322 100644 --- a/content/content-management/sections.md +++ b/content/content-management/sections.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [content management] tags: [lists,sections,content types,organization] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 50 weight: 50 #rem draft: false diff --git a/content/content-management/shortcodes.md b/content/content-management/shortcodes.md index b1f193520..81a374d6e 100644 --- a/content/content-management/shortcodes.md +++ b/content/content-management/shortcodes.md @@ -7,8 +7,8 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-03-31 menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 25 weight: 25 #rem categories: [content management] diff --git a/content/content-management/summaries.md b/content/content-management/summaries.md index a39f4b845..e128ad581 100644 --- a/content/content-management/summaries.md +++ b/content/content-management/summaries.md @@ -8,8 +8,8 @@ lastmod: 2017-01-10 categories: [content management] tags: [summaries,abstracts,read more] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 90 weight: 90 #rem draft: false diff --git a/content/content-management/taxonomies.md b/content/content-management/taxonomies.md index 61fc75065..7e8a607a7 100644 --- a/content/content-management/taxonomies.md +++ b/content/content-management/taxonomies.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 tags: [taxonomies,metadata,front matter,terms] categories: [content management] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 80 weight: 80 #rem draft: false diff --git a/content/content-management/toc.md b/content/content-management/toc.md index 1e0b72b09..f666926df 100644 --- a/content/content-management/toc.md +++ b/content/content-management/toc.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [content management] tags: [table of contents, toc] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 130 weight: 130 #rem draft: false diff --git a/content/content-management/types.md b/content/content-management/types.md index af1ca4df4..2eadd6177 100644 --- a/content/content-management/types.md +++ b/content/content-management/types.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [content management] tags: [lists,sections,content types,types,organization] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 60 weight: 60 #rem draft: false diff --git a/content/content-management/urls.md b/content/content-management/urls.md index 093efa52e..a97c25984 100644 --- a/content/content-management/urls.md +++ b/content/content-management/urls.md @@ -8,8 +8,8 @@ lastmod: 2017-03-09 tags: [aliases,redirects,permalinks,urls] categories: [content management] menu: - main: - parent: "Content Management" + docs: + parent: "content-management" weight: 110 weight: 110 #rem draft: false diff --git a/content/contribute/_index.md b/content/contribute/_index.md index d296f3380..b78c7df57 100644 --- a/content/contribute/_index.md +++ b/content/contribute/_index.md @@ -1,6 +1,6 @@ --- title: Contributing to the Hugo Project -linktitle: Overview +linktitle: Contributing description: Contribute to Hugo development and documentation. date: 2017-02-01 publishdate: 2017-02-01 @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [contribute] tags: [] menu: - main: - parent: "Contribute" + docs: + parent: "contribute" weight: 01 weight: 01 #rem draft: false @@ -20,4 +20,4 @@ toc: false Hugo relies heavily on the enthusiasm and participation of the open-source community. We need your support in both its development and documentation. -Hugo's contribution guidelines are [detailed in a `CONTRIBUTING.md`](https://github.com/spf13/hugo/blob/master/CONTRIBUTING.md) in the Hugo source repository on GitHub. \ No newline at end of file +Hugo's contribution guidelines are [detailed in a `CONTRIBUTING.md`](https://github.com/spf13/hugo/blob/master/CONTRIBUTING.md) in the Hugo source repository on GitHub. diff --git a/content/contribute/development.md b/content/contribute/development.md index 523c603e8..fdf0ef447 100644 --- a/content/contribute/development.md +++ b/content/contribute/development.md @@ -9,8 +9,8 @@ categories: [contribute] tags: [dev,open source] authors: [digitalcraftsman] menu: - main: - parent: "Contribute" + docs: + parent: "contribute" weight: 10 weight: 10 sections_weight: 10 @@ -411,4 +411,4 @@ Feel free to [open an issue][newissue] if you think you found a bug or you have [releases]: /getting-started/ [setupgopath]: https://golang.org/doc/code.html#Workspaces [thinkful]: https://www.thinkful.com/learn/github-pull-request-tutorial/ -[trygit]: https://try.github.io/levels/1/challenges/1 \ No newline at end of file +[trygit]: https://try.github.io/levels/1/challenges/1 diff --git a/content/contribute/documentation.md b/content/contribute/documentation.md index 9b32a7a52..19ef6a0a8 100644 --- a/content/contribute/documentation.md +++ b/content/contribute/documentation.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [contribute] tags: [docs,documentation,community, contribute] menu: - main: - parent: "Contribute" + docs: + parent: "contribute" weight: 20 weight: 20 sections_weight: 20 diff --git a/content/contribute/themes.md b/content/contribute/themes.md index 58df96c2f..421534d84 100644 --- a/content/contribute/themes.md +++ b/content/contribute/themes.md @@ -9,8 +9,8 @@ categories: [contribute] tags: [contribute,themes,design] authors: [digitalcraftsman] menu: - main: - parent: "Contribute" + docs: + parent: "contribute" weight: 30 weight: 30 sections_weight: 30 diff --git a/content/functions/GetPage.md b/content/functions/GetPage.md index 5e3229d7a..7cfedb68e 100644 --- a/content/functions/GetPage.md +++ b/content/functions/GetPage.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [sections,lists,indexes] ns: signature: ["GetPage TYPE PATH"] diff --git a/content/functions/_index.md b/content/functions/_index.md index da3df204f..f2ae0edee 100644 --- a/content/functions/_index.md +++ b/content/functions/_index.md @@ -1,6 +1,5 @@ --- -title: Functions Quick Reference -linktitle: Quick Reference +title: Functions description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. godocref: date: 2017-02-01 @@ -8,9 +7,8 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [] menu: - main: - parent: "Functions" - weight: 01 + docs: + parent: "functions" weight: 01 #rem draft: false aliases: [/layout/functions/] @@ -18,4 +16,4 @@ aliases: [/layout/functions/] Go templates are lightweight but extensible. Go itself supplies built-in functions, including comparison operators and other basic tools. These are listed in the [Go template documentation][gofuncs]. Hugo has added additional functions to the basic template logic. -[gofuncs]: http://golang.org/pkg/text/template/#hdr-Functions \ No newline at end of file +[gofuncs]: http://golang.org/pkg/text/template/#hdr-Functions diff --git a/content/functions/abslangurl.md b/content/functions/abslangurl.md index 47c547428..7e5caf038 100644 --- a/content/functions/abslangurl.md +++ b/content/functions/abslangurl.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [multilingual,i18n,urls] ns: signature: ["absLangURL INPUT"] diff --git a/content/functions/absurl.md b/content/functions/absurl.md index 304d4b971..bef48e0fa 100644 --- a/content/functions/absurl.md +++ b/content/functions/absurl.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [urls] ns: signature: ["absURL INPUT"] diff --git a/content/functions/adddate.md b/content/functions/adddate.md index 5c8b97e94..31d133ab3 100644 --- a/content/functions/adddate.md +++ b/content/functions/adddate.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [dates,time] ns: signature: ["AddDate YEARS MONTHS DAYS"] diff --git a/content/functions/after.md b/content/functions/after.md index e4f9a68ad..9fd1c0a88 100644 --- a/content/functions/after.md +++ b/content/functions/after.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [iteration] ns: signature: ["after INDEX COLLECTION"] diff --git a/content/functions/apply.md b/content/functions/apply.md index 8287e5832..485ce997b 100644 --- a/content/functions/apply.md +++ b/content/functions/apply.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [advanced] ns: signature: ["apply COLLETION FUNCTION [PARAM...]"] diff --git a/content/functions/base64.md b/content/functions/base64.md index 6177f1e16..9362fff61 100644 --- a/content/functions/base64.md +++ b/content/functions/base64.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] relatedfuncs: [] ns: diff --git a/content/functions/chomp.md b/content/functions/chomp.md index a15d44336..9c678cb91 100644 --- a/content/functions/chomp.md +++ b/content/functions/chomp.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [trim] ns: signature: ["chomp INPUT"] diff --git a/content/functions/countrunes.md b/content/functions/countrunes.md index c6160d652..a06de318b 100644 --- a/content/functions/countrunes.md +++ b/content/functions/countrunes.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [counting, word count] ns: signature: ["countrunes INPUT"] diff --git a/content/functions/countwords.md b/content/functions/countwords.md index d0148cd20..dee72c8b8 100644 --- a/content/functions/countwords.md +++ b/content/functions/countwords.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [counting, word count] ns: signature: ["countwords INPUT"] diff --git a/content/functions/dateformat.md b/content/functions/dateformat.md index 187e1cdd5..ff9fa4c94 100644 --- a/content/functions/dateformat.md +++ b/content/functions/dateformat.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [dates,time,strings] ns: signature: ["dateFormat LAYOUT INPUT"] diff --git a/content/functions/default.md b/content/functions/default.md index 59183b1ce..ff294088d 100644 --- a/content/functions/default.md +++ b/content/functions/default.md @@ -9,6 +9,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [defaults] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: ["default DEFAULT INPUT"] @@ -102,8 +105,3 @@ Using `with`: => Sane Defaults ``` {{% /code %}} - - - - - diff --git a/content/functions/delimit.md b/content/functions/delimit.md index 9e1a6b96c..ac79f35c1 100644 --- a/content/functions/delimit.md +++ b/content/functions/delimit.md @@ -8,6 +8,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [iteration] toc: false ns: diff --git a/content/functions/dict.md b/content/functions/dict.md index 691abc141..d8441964e 100644 --- a/content/functions/dict.md +++ b/content/functions/dict.md @@ -8,6 +8,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-26 categories: [functions] +menu: + docs: + parent: "functions" tags: [dictionary] ns: signature: ["dict KEY VALUE [KEY VALUE]..."] diff --git a/content/functions/echoparam.md b/content/functions/echoparam.md index 6242107f0..2e841cead 100644 --- a/content/functions/echoparam.md +++ b/content/functions/echoparam.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["echoParam DICTIONARY KEY"] diff --git a/content/functions/emojify.md b/content/functions/emojify.md index c4917d3b5..ab47dde2d 100644 --- a/content/functions/emojify.md +++ b/content/functions/emojify.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,emojis] ns: signature: ["emojify INPUT"] diff --git a/content/functions/eq.md b/content/functions/eq.md index b21b35d37..aaf8b215e 100644 --- a/content/functions/eq.md +++ b/content/functions/eq.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [operators,logic] ns: signature: ["eq ARG1 ARG2"] diff --git a/content/functions/findRe.md b/content/functions/findRe.md index d191ca2b9..89a555787 100644 --- a/content/functions/findRe.md +++ b/content/functions/findRe.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [regex] ns: signature: ["findRE PATTERN INPUT [LIMIT]"] diff --git a/content/functions/first.md b/content/functions/first.md index 029846f6f..671ecd69a 100644 --- a/content/functions/first.md +++ b/content/functions/first.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [iteration] ns: signature: ["first LIMIT COLLECTION"] diff --git a/content/functions/format.md b/content/functions/format.md index 0cffd44cf..0516853ce 100644 --- a/content/functions/format.md +++ b/content/functions/format.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [dates,time] ns: signature: ["Format FORMAT"] diff --git a/content/functions/get.md b/content/functions/get.md index 9a21fddfd..57c4e7a20 100644 --- a/content/functions/get.md +++ b/content/functions/get.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [shortcodes] ns: signature: ["Get INDEX", "Get KEY"] diff --git a/content/functions/getenv.md b/content/functions/getenv.md index 16f98495e..f725388e6 100644 --- a/content/functions/getenv.md +++ b/content/functions/getenv.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["getenv VARIABLE"] diff --git a/content/functions/hasPrefix.md b/content/functions/hasPrefix.md index 7be2cca0c..c5ff35c12 100644 --- a/content/functions/hasPrefix.md +++ b/content/functions/hasPrefix.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["hasPrefix STRING PREFIX"] diff --git a/content/functions/haschildren.md b/content/functions/haschildren.md index 415819a52..4b5c12bdc 100644 --- a/content/functions/haschildren.md +++ b/content/functions/haschildren.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [menus] toc: ns: diff --git a/content/functions/hasmenucurrent.md b/content/functions/hasmenucurrent.md index 834f6f177..0ec51e90a 100644 --- a/content/functions/hasmenucurrent.md +++ b/content/functions/hasmenucurrent.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [menus] ns: signature: ["HasMenuCurrent"] diff --git a/content/functions/highlight.md b/content/functions/highlight.md index 19f7e0cdc..8e2f02ad9 100644 --- a/content/functions/highlight.md +++ b/content/functions/highlight.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [highlighting,pygments,code blocks,syntax] ns: signature: ["highlight INPUT"] diff --git a/content/functions/htmlEscape.md b/content/functions/htmlEscape.md index 4f03a107a..c847fe0b9 100644 --- a/content/functions/htmlEscape.md +++ b/content/functions/htmlEscape.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings, html] ns: signature: ["htmlEscape INPUT"] diff --git a/content/functions/htmlUnescape.md b/content/functions/htmlUnescape.md index d55578c3b..89f35408c 100644 --- a/content/functions/htmlUnescape.md +++ b/content/functions/htmlUnescape.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["htmlUnescape INPUT"] diff --git a/content/functions/humanize.md b/content/functions/humanize.md index 48fdc6e61..e62230c91 100644 --- a/content/functions/humanize.md +++ b/content/functions/humanize.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,casing] ns: signature: ["humanize INPUT"] diff --git a/content/functions/i18n.md b/content/functions/i18n.md index abf91b05c..67daa6aa8 100644 --- a/content/functions/i18n.md +++ b/content/functions/i18n.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [internationalization,i18n,multilingual] ns: signature: ["i18n KEY", "T KEY"] diff --git a/content/functions/imageConfig.md b/content/functions/imageConfig.md index d0ab77e59..cc8f56dad 100644 --- a/content/functions/imageConfig.md +++ b/content/functions/imageConfig.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [images] ns: signature: ["imageConfig PATH"] diff --git a/content/functions/in.md b/content/functions/in.md index f2924f916..6960cc385 100644 --- a/content/functions/in.md +++ b/content/functions/in.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["in SET ITEM"] diff --git a/content/functions/index-function.md b/content/functions/index-function.md index 9c152a272..09a4cfe65 100644 --- a/content/functions/index-function.md +++ b/content/functions/index-function.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["index COLLECTION INDEX", "index COLLECTION KEY"] diff --git a/content/functions/int.md b/content/functions/int.md index 59e194d74..eb1908ec7 100644 --- a/content/functions/int.md +++ b/content/functions/int.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,integers] ns: signature: ["int INPUT"] diff --git a/content/functions/intersect.md b/content/functions/intersect.md index c230d8b10..1f5b7fd04 100644 --- a/content/functions/intersect.md +++ b/content/functions/intersect.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["intersect SET1 SET2"] diff --git a/content/functions/ismenucurrent.md b/content/functions/ismenucurrent.md index 5f5a002db..b25e74879 100644 --- a/content/functions/ismenucurrent.md +++ b/content/functions/ismenucurrent.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [menus] ns: signature: ["IsMenuCurrent"] diff --git a/content/functions/isset.md b/content/functions/isset.md index 3757f54ef..4f68686e6 100644 --- a/content/functions/isset.md +++ b/content/functions/isset.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["isset COLLECTION INDEX", "isset COLLECTION KEY"] diff --git a/content/functions/jsonify.md b/content/functions/jsonify.md index 12327d929..7ada00731 100644 --- a/content/functions/jsonify.md +++ b/content/functions/jsonify.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,json] ns: signature: ["jsonify INPUT"] diff --git a/content/functions/last.md b/content/functions/last.md index 80729557e..04b3d6231 100644 --- a/content/functions/last.md +++ b/content/functions/last.md @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: ["last INDEX COLLECTION"] diff --git a/content/functions/lower.md b/content/functions/lower.md index 6e6d76463..08d554c4c 100644 --- a/content/functions/lower.md +++ b/content/functions/lower.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,casing] ns: signature: ["lower INPUT"] diff --git a/content/functions/markdownify.md b/content/functions/markdownify.md index fe3c618b8..76b0db186 100644 --- a/content/functions/markdownify.md +++ b/content/functions/markdownify.md @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [markdown,content] categories: [functions] +menu: + docs: + parent: "functions" ns: signature: ["markdownify INPUT"] workson: [] diff --git a/content/functions/math.md b/content/functions/math.md index 767589eee..68f997753 100644 --- a/content/functions/math.md +++ b/content/functions/math.md @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [math, operators] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: [] diff --git a/content/functions/md5.md b/content/functions/md5.md index 257048d3c..d7cd8d99b 100644 --- a/content/functions/md5.md +++ b/content/functions/md5.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["md5 INPUT"] diff --git a/content/functions/now.md b/content/functions/now.md index dd92fd646..f4dd319ca 100644 --- a/content/functions/now.md +++ b/content/functions/now.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-04-30 categories: [functions] +menu: + docs: + parent: "functions" tags: [dates,time] ns: signature: ["now"] diff --git a/content/functions/param.md b/content/functions/param.md index edadc7972..7ac2e7201 100644 --- a/content/functions/param.md +++ b/content/functions/param.md @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-04-30 tags: ["front matter"] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: ["Param KEY"] diff --git a/content/functions/partialCached.md b/content/functions/partialCached.md index 3fc6a4683..1fb03dc8b 100644 --- a/content/functions/partialCached.md +++ b/content/functions/partialCached.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["partialCached LAYOUT INPUT [VARIANT...]"] diff --git a/content/functions/plainify.md b/content/functions/plainify.md index f0ceb5fdd..2b0f109fd 100644 --- a/content/functions/plainify.md +++ b/content/functions/plainify.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-04-30 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["plainify INPUT"] diff --git a/content/functions/pluralize.md b/content/functions/pluralize.md index b29fc3149..1997ec43b 100644 --- a/content/functions/pluralize.md +++ b/content/functions/pluralize.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["pluralize INPUT"] diff --git a/content/functions/printf.md b/content/functions/printf.md index e44e631e0..73563ea0a 100644 --- a/content/functions/printf.md +++ b/content/functions/printf.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["printf FORMAT INPUT"] diff --git a/content/functions/querify.md b/content/functions/querify.md index 75b9cd6ea..b97d327fb 100644 --- a/content/functions/querify.md +++ b/content/functions/querify.md @@ -6,6 +6,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [urls] godocref: ns: diff --git a/content/functions/range.md b/content/functions/range.md index 90b45e522..dbb1dd9e3 100644 --- a/content/functions/range.md +++ b/content/functions/range.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [iteration,fundamentals] ns: signature: ["range COLLECTION"] diff --git a/content/functions/readdir.md b/content/functions/readdir.md index 6bb6ea774..73371a1a9 100644 --- a/content/functions/readdir.md +++ b/content/functions/readdir.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [files] ns: signature: ["readDir PATH"] diff --git a/content/functions/readfile.md b/content/functions/readfile.md index d3f64da2b..66b2d9755 100644 --- a/content/functions/readfile.md +++ b/content/functions/readfile.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-04-30 categories: [functions] +menu: + docs: + parent: "functions" tags: [files] ns: signature: ["readFile PATH"] diff --git a/content/functions/ref.md b/content/functions/ref.md index b35b8da9c..771cd2c1f 100644 --- a/content/functions/ref.md +++ b/content/functions/ref.md @@ -7,6 +7,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [cross references, anchors] ns: signature: ["ref PAGE CONTENT"] diff --git a/content/functions/relLangURL.md b/content/functions/relLangURL.md index 2230e85aa..988c13cb7 100644 --- a/content/functions/relLangURL.md +++ b/content/functions/relLangURL.md @@ -1,6 +1,6 @@ --- title: rellangurl -linktitle: relLangURL +# linktitle: relLangURL description: Adds the relative URL with correct language prefix according to site configuration for multilingual. godocref: date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [multilingual,i18n,urls] categories: [functions] +menu: + docs: + parent: "functions" ns: signature: ["relLangURL INPUT"] workson: [] diff --git a/content/functions/relref.md b/content/functions/relref.md index 40c266b9a..9dfba0ecb 100644 --- a/content/functions/relref.md +++ b/content/functions/relref.md @@ -1,12 +1,15 @@ --- title: relref -linktitle: relref +# linktitle: relref description: Looks up a content page by relative path. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [cross references, anchors] ns: signature: ["relref PAGE CONTENT"] diff --git a/content/functions/relurl.md b/content/functions/relurl.md index 44702de4c..b5424a245 100644 --- a/content/functions/relurl.md +++ b/content/functions/relurl.md @@ -1,12 +1,15 @@ --- title: relurl -linktitle: relURL +# linktitle: relURL description: Given a string, prepends the relative URL according to a page's position in the project directory structure. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [urls] ns: signature: ["relURL INPUT"] diff --git a/content/functions/render.md b/content/functions/render.md index 6ebf06eb8..960b9bb20 100644 --- a/content/functions/render.md +++ b/content/functions/render.md @@ -1,12 +1,15 @@ --- title: render -linktitle: Render +# linktitle: Render description: Takes a view to apply when rendering content. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [views] ns: signature: ["render LAYOUT"] diff --git a/content/functions/replace.md b/content/functions/replace.md index aa6b97e3f..89d91f89d 100644 --- a/content/functions/replace.md +++ b/content/functions/replace.md @@ -1,12 +1,15 @@ --- title: replace -linktitle: replace +# linktitle: replace description: Replaces all occurrences of the search string with the replacement string. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["replace INPUT OLD NEW"] diff --git a/content/functions/replacere.md b/content/functions/replacere.md index 838459453..1afd94d38 100644 --- a/content/functions/replacere.md +++ b/content/functions/replacere.md @@ -1,12 +1,15 @@ --- title: replacere -linktitle: replaceRE +# linktitle: replaceRE description: Replaces all occurrences of a regular expression with the replacement pattern. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-04-30 categories: [functions] +menu: + docs: + parent: "functions" tags: [regex] ns: signature: ["replaceRE PATTERN REPLACEMENT INPUT"] diff --git a/content/functions/safeCSS.md b/content/functions/safeCSS.md index b0d4ed9b7..33845f5bb 100644 --- a/content/functions/safeCSS.md +++ b/content/functions/safeCSS.md @@ -1,12 +1,15 @@ --- title: safecss -linktitle: safeCSS +# linktitle: safeCSS description: Declares the provided string as a known "safe" CSS string. godocref: https://golang.org/src/html/template/content.go?s=919:929#L15 date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-26 categories: [functions] +menu: + docs: + parent: "functions" tags: [style,css,strings] ns: signature: ["safeCSS INPUT"] diff --git a/content/functions/safeHTML.md b/content/functions/safeHTML.md index 6438d9698..8f6ae348a 100644 --- a/content/functions/safeHTML.md +++ b/content/functions/safeHTML.md @@ -1,12 +1,15 @@ --- title: safeHTML -linktitle: +# linktitle: description: Declares a provided string as a "safe" HTML document to avoid escaping by Go templates. godocref: https://golang.org/src/html/template/content.go?s=1374:1385#L25 date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["safeHTML INPUT"] diff --git a/content/functions/safeHTMLAttr.md b/content/functions/safeHTMLAttr.md index f8b3ce0ca..6fda3e321 100644 --- a/content/functions/safeHTMLAttr.md +++ b/content/functions/safeHTMLAttr.md @@ -1,12 +1,15 @@ --- title: safeHTMLAttr -linktitle: safeHTMLAttr +# linktitle: safeHTMLAttr description: Declares the provided string as a "safe" HTML attribute. godocref: https://golang.org/src/html/template/content.go?s=1661:1676#L33 date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["safeHTMLAttr INPUT"] diff --git a/content/functions/safeJS.md b/content/functions/safeJS.md index b2238a83a..2d46b7db7 100644 --- a/content/functions/safeJS.md +++ b/content/functions/safeJS.md @@ -1,12 +1,15 @@ --- title: safeJS -linktitle: +# linktitle: description: Declares the provided string as a known "safe" JavaScript string. godocref: https://golang.org/src/html/template/content.go?s=2548:2557#L51 date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["safeJS INPUT"] diff --git a/content/functions/safeURL.md b/content/functions/safeURL.md index 89fd24277..7bf81d07a 100644 --- a/content/functions/safeURL.md +++ b/content/functions/safeURL.md @@ -1,6 +1,6 @@ --- title: safeurl -linktitle: safeURL +# linktitle: safeURL description: Declares the provided string as a safe URL or URL substring. godocref: https://golang.org/pkg/html/template/#HTMLEscape date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [strings,urls] categories: [functions] +menu: + docs: + parent: "functions" ns: signature: ["safeURL INPUT"] workson: [] diff --git a/content/functions/scratch.md b/content/functions/scratch.md index 6594c6619..55b21cc56 100644 --- a/content/functions/scratch.md +++ b/content/functions/scratch.md @@ -1,6 +1,6 @@ --- title: scratch -linktitle: Scratch +# linktitle: Scratch description: Acts as a "scratchpad" to allow for writable page-scoped variables. godocref: date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [iteration] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: [] diff --git a/content/functions/seq.md b/content/functions/seq.md index 053fbb746..fae119e6b 100644 --- a/content/functions/seq.md +++ b/content/functions/seq.md @@ -1,12 +1,15 @@ --- title: seq -linktitle: +# linktitle: description: Creates a sequence of integers. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [] ns: signature: ["seq LAST", "seq FIRST LAST", "seq FIRST INCREMENT LAST"] diff --git a/content/functions/sha.md b/content/functions/sha.md index 7258bcab8..a7ba296f3 100644 --- a/content/functions/sha.md +++ b/content/functions/sha.md @@ -1,12 +1,15 @@ --- title: sha -linktitle: sha +# linktitle: sha description: Hashes the given input and returns either an SHA1 or SHA256 checksum. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [sha,checksum] ns: signature: ["sha1 INPUT", "sha256 INPUT"] diff --git a/content/functions/shuffle.md b/content/functions/shuffle.md index 778a2afb8..63b859767 100644 --- a/content/functions/shuffle.md +++ b/content/functions/shuffle.md @@ -1,6 +1,6 @@ --- title: shuffle -linktitle: +# linktitle: description: Returns a random permutation of a given array or slice. godocref: date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-04-30 tags: [ordering] categories: [functions] +menu: + docs: + parent: "functions" ns: signature: ["shuffle COLLECTION"] workson: [] diff --git a/content/functions/singularize.md b/content/functions/singularize.md index 725c8e3af..3212764e3 100644 --- a/content/functions/singularize.md +++ b/content/functions/singularize.md @@ -1,12 +1,15 @@ --- title: singularize -linktitle: singularize +# linktitle: singularize description: Converts a word according to a set of common English singularization rules. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings,singular] ns: signature: ["singularize INPUT"] diff --git a/content/functions/slice.md b/content/functions/slice.md index f45d0c0e7..33a0b570d 100644 --- a/content/functions/slice.md +++ b/content/functions/slice.md @@ -1,12 +1,15 @@ --- title: slice -linktitle: slice +# linktitle: slice description: Creates an array (`[]interface{}``) of all passed arguments. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [slice, array, interface] ns: signature: ["slice ITEM..."] diff --git a/content/functions/slicestr.md b/content/functions/slicestr.md index eb5b723b8..0e1048dfc 100644 --- a/content/functions/slicestr.md +++ b/content/functions/slicestr.md @@ -1,12 +1,15 @@ --- title: slicestr -linktitle: +# linktitle: description: Creates a slice of a half-open range, including start and end indices. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["slicestr STRING START [END]"] diff --git a/content/functions/sort.md b/content/functions/sort.md index 2944b95b7..e36ed56b5 100644 --- a/content/functions/sort.md +++ b/content/functions/sort.md @@ -1,12 +1,15 @@ --- title: sort -linktitle: sort +# linktitle: sort description: Sorts maps, arrays, and slices and returns a sorted slice. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [ordering,sorting,lists] ns: signature: [] diff --git a/content/functions/split.md b/content/functions/split.md index 3a5901cd6..20a62d6bf 100644 --- a/content/functions/split.md +++ b/content/functions/split.md @@ -1,12 +1,15 @@ --- title: split -linktitle: split +# linktitle: split description: splits a string into substrings separated by a delimiter godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["split STRING DELIM"] diff --git a/content/functions/string.md b/content/functions/string.md index b34c13efb..44cc548dd 100644 --- a/content/functions/string.md +++ b/content/functions/string.md @@ -1,12 +1,15 @@ --- title: string -linktitle: string +# linktitle: string description: Creates a string from the argument passed to the function godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["string INPUT"] diff --git a/content/functions/substr.md b/content/functions/substr.md index 8567749d1..5a67f0002 100644 --- a/content/functions/substr.md +++ b/content/functions/substr.md @@ -1,12 +1,15 @@ --- title: substr -linktitle: +# linktitle: description: Extracts parts of a string from a specified character's position and returns the specified number of characters. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] aliases: [] ns: diff --git a/content/functions/time.md b/content/functions/time.md index da5f4c198..962d3761b 100644 --- a/content/functions/time.md +++ b/content/functions/time.md @@ -1,12 +1,15 @@ --- title: time -linktitle: +# linktitle: description: Converts a timestamp string into a `time.Time` structure. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [dates,time] ns: signature: ["time INPUT"] diff --git a/content/functions/title.md b/content/functions/title.md index e66ff7dc2..e14994c7f 100644 --- a/content/functions/title.md +++ b/content/functions/title.md @@ -1,12 +1,15 @@ --- title: title -linktitle: +# linktitle: description: Converts all characters in the provided string to title case. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [fundamentals,strings] ns: signature: ["title INPUT"] diff --git a/content/functions/trim.md b/content/functions/trim.md index d219c13c5..07991528a 100644 --- a/content/functions/trim.md +++ b/content/functions/trim.md @@ -1,12 +1,15 @@ --- title: trim -linktitle: +# linktitle: description: Returns a slice of a passed string with all leading and trailing characters from cutset removed. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["trim INPUT CUTSET"] diff --git a/content/functions/truncate.md b/content/functions/truncate.md index f1328fe9c..259649008 100644 --- a/content/functions/truncate.md +++ b/content/functions/truncate.md @@ -1,12 +1,15 @@ --- title: truncate -linktitle: truncate +# linktitle: truncate description: Truncates a text to a max length without cutting words or leaving unclosed HTML tags. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [strings] ns: signature: ["truncate SIZE INPUT", "truncate SIZE ELLIPSIS INPUT"] diff --git a/content/functions/union.md b/content/functions/union.md index 6795c80c4..3a1065fc5 100644 --- a/content/functions/union.md +++ b/content/functions/union.md @@ -1,12 +1,15 @@ --- title: union -linktitle: union +# linktitle: union description: Given two arrays or slices, returns a new array that contains the elements or objects that belong to either or both arrays/slices. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-03-12 categories: [functions] +menu: + docs: + parent: "functions" tags: [filtering,lists] ns: signature: ["union SET1 SET2"] diff --git a/content/functions/unix.md b/content/functions/unix.md index 1751afcf8..44148325b 100644 --- a/content/functions/unix.md +++ b/content/functions/unix.md @@ -1,6 +1,6 @@ --- title: unix -linktitle: Unix +# linktitle: Unix description: Unix returns the local Time corresponding to the given Unix time, sec seconds and nsec nanoseconds since January 1, 1970 UTC. godocref: https://golang.org/search?q=Unix#Functions date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [dates,time] categories: [functions] +menu: + docs: + parent: "functions" ns: signature: ["Unix"] workson: [times] diff --git a/content/functions/upper.md b/content/functions/upper.md index e82e8b4fe..33831acbb 100644 --- a/content/functions/upper.md +++ b/content/functions/upper.md @@ -1,6 +1,6 @@ --- title: upper -linktitle: upper +# linktitle: upper description: Converts all characters in a string to uppercase godocref: date: 2017-02-01 @@ -8,6 +8,9 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 tags: [] categories: [functions] +menu: + docs: + parent: "functions" toc: ns: signature: ["upper INPUT"] diff --git a/content/functions/urlize.md b/content/functions/urlize.md index ee9a6d58b..c26e7627d 100644 --- a/content/functions/urlize.md +++ b/content/functions/urlize.md @@ -1,11 +1,14 @@ --- title: urlize -linktitle: urlize +# linktitle: urlize description: Takes a string, sanitizes it for usage in URLs, and converts spaces to hyphens. date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [functions] +menu: + docs: + parent: "functions" tags: [urls,strings] godocref: ns: diff --git a/content/functions/where.md b/content/functions/where.md index 6f7bfb83e..b9f08ccba 100644 --- a/content/functions/where.md +++ b/content/functions/where.md @@ -1,13 +1,16 @@ --- title: where -linktitle: where +# linktitle: where description: Filters an array to only the elements containing a matching value for a given field. godocref: date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-04-30 +lastmod: 2017-02-01 categories: [functions] -tags: [filtering,logic,operators] +menu: + docs: + parent: "functions" +tags: [filtering] ns: signature: ["where COLLECTION KEY [OPERATOR] MATCH"] workson: [lists,taxonomies,terms,groups] @@ -101,7 +104,7 @@ You can also put the returned value of the `where` clauses into a variable: ## Using `where` with `first` -The following ranges through the first five content files in the `post` section using the [default ordering](/templates/lists/) for lists (i.e., `weight => date`): +The following grabs the first five content files in `post` using the [default ordering](/templates/lists/) for lists (i.e., `weight => date`): {{% code file="where-with-first.html" %}} ```html @@ -113,7 +116,7 @@ The following ranges through the first five content files in the `post` section ## Nesting `where` Clauses -You can also nest `where` clauses to drill down on lists of content by more than one parameter. The following example first grabs all pages in the `blog` section and then ranges through only those pages that are *not* featured: +You can also nest `where` clauses to drill down on lists of content by more than one parameter. The following first grabs all pages in the "blog" section and then ranges through the result of the first `where` clause and finds all pages that are *not* featured: ```html {{ range where (where .Data.Pages "Section" "blog" ) ".Params.featured" "!=" "true" }} diff --git a/content/functions/with.md b/content/functions/with.md index ef9bf5256..4696d5d47 100644 --- a/content/functions/with.md +++ b/content/functions/with.md @@ -1,12 +1,15 @@ --- title: with -linktitle: with +# linktitle: with description: Rebinds the context (`.`) within its scope and skips the block if the variable is absent. godocref: date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-03-12 categories: [functions] +menu: + docs: + parent: "functions" tags: [conditionals,fundamentals] ns: signature: ["with INPUT"] diff --git a/content/getting-started/_index.md b/content/getting-started/_index.md index 995718f42..edb622498 100644 --- a/content/getting-started/_index.md +++ b/content/getting-started/_index.md @@ -1,6 +1,6 @@ --- title: Getting Started -linktitle: Overview +# linktitle: Overview Getting Started description: Quick start and guides for installing Hugo on your preferred operating system. date: 2017-02-01 publishdate: 2017-02-01 @@ -8,10 +8,10 @@ lastmod: 2017-02-01 categories: [getting started] tags: [usage,docs] menu: - main: - parent: "Getting Started" - weight: 01 -weight: 01 #rem + docs: + parent: "getting-started" + weight: 1 +weight: 0001 #rem draft: false aliases: [/overview/introduction/] toc: false @@ -20,4 +20,4 @@ toc: false If this is your first time using Hugo and you've [already installed Hugo on your machine][installed], we recommend the [quick start][]. [installed]: /getting-started/installing/ -[quick start]: /getting-started/quick-start/ \ No newline at end of file +[quick start]: /getting-started/quick-start/ diff --git a/content/getting-started/configuration.md b/content/getting-started/configuration.md index 315397941..999c90ac4 100644 --- a/content/getting-started/configuration.md +++ b/content/getting-started/configuration.md @@ -8,8 +8,8 @@ lastmod: 2017-03-05 categories: [getting started] tags: [configuration,fundamentals,toml,yaml,json] menu: - main: - parent: "Getting Started" + docs: + parent: "getting-started" weight: 60 weight: 60 sections_weight: 60 diff --git a/content/getting-started/directory-structure.md b/content/getting-started/directory-structure.md index 4b02ea806..d2afa8be2 100644 --- a/content/getting-started/directory-structure.md +++ b/content/getting-started/directory-structure.md @@ -8,8 +8,8 @@ lastmod: 2017-03-09 categories: [getting started] tags: [source, organization, directories,fundamentals] menu: - main: - parent: "Getting Started" + docs: + parent: "getting-started" weight: 50 weight: 50 sections_weight: 50 diff --git a/content/getting-started/installing.md b/content/getting-started/installing.md index 9371e6a46..e759a3611 100644 --- a/content/getting-started/installing.md +++ b/content/getting-started/installing.md @@ -9,8 +9,8 @@ categories: [getting started] authors: ["Michael Henderson"] tags: [install,fundamentals,pc,windows,linux,macos,binary,tarball] menu: - main: - parent: "Getting Started" + docs: + parent: "getting-started" weight: 30 weight: 30 sections_weight: 30 diff --git a/content/getting-started/quick-start.md b/content/getting-started/quick-start.md index f074db355..55a334670 100644 --- a/content/getting-started/quick-start.md +++ b/content/getting-started/quick-start.md @@ -9,8 +9,8 @@ categories: [getting started] tags: [quick start,usage] authors: [Shekhar Gulati, Ryan Watters] menu: - main: - parent: "Getting Started" + docs: + parent: "getting-started" weight: 10 weight: 10 sections_weight: 10 @@ -582,4 +582,4 @@ Here's what you should look into next: [sitemenu]: /content-management/menus/ [templating]: /templates/ [themessection]: /themes/ -[themes]: /themes/ \ No newline at end of file +[themes]: /themes/ diff --git a/content/getting-started/usage.md b/content/getting-started/usage.md index 94da93a6a..c24138beb 100644 --- a/content/getting-started/usage.md +++ b/content/getting-started/usage.md @@ -8,8 +8,8 @@ lastmod: 2017-02-01 categories: [getting started] tags: [usage,livereload,command line,flags] menu: - main: - parent: "Getting Started" + docs: + parent: "getting-started" weight: 40 weight: 40 sections_weight: 40 diff --git a/content/hosting-and-deployment/_index.md b/content/hosting-and-deployment/_index.md index ffdf364d2..b17e6f908 100644 --- a/content/hosting-and-deployment/_index.md +++ b/content/hosting-and-deployment/_index.md @@ -1,6 +1,6 @@ --- -title: Hosting and Deployment -linktitle: Overview +title: Hosting & Deployment +linktitle: Hosting & Deployment description: Site builds, automated deployments, and popular hosting solutions. date: 2016-11-01 publishdate: 2016-11-01 @@ -8,8 +8,8 @@ lastmod: 2016-11-01 categories: [hosting and deployment] tags: [] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 01 weight: 01 #rem draft: false @@ -17,4 +17,4 @@ aliases: [] toc: false --- -Because Hugo renders *static* websites, you can host your new Hugo website virtually anywhere. The following represent only a few of the more popular hosting and automated deployment solutions used by the Hugo community. \ No newline at end of file +Because Hugo renders *static* websites, you can host your new Hugo website virtually anywhere. The following represent only a few of the more popular hosting and automated deployment solutions used by the Hugo community. diff --git a/content/hosting-and-deployment/deployment-with-rsync.md b/content/hosting-and-deployment/deployment-with-rsync.md index cf8926b10..7bdcc0d7d 100644 --- a/content/hosting-and-deployment/deployment-with-rsync.md +++ b/content/hosting-and-deployment/deployment-with-rsync.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [rysnc,deployment] authors: [Adrien Poupin] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 70 weight: 70 sections_weight: 70 @@ -136,4 +136,4 @@ tarifs-contact/index.html sent 9,550 bytes received 1,708 bytes 7,505.33 bytes/sec total size is 966,557 speedup is 85.86 -``` \ No newline at end of file +``` diff --git a/content/hosting-and-deployment/deployment-with-wercker.md b/content/hosting-and-deployment/deployment-with-wercker.md index e36a53634..e27d98ddb 100644 --- a/content/hosting-and-deployment/deployment-with-wercker.md +++ b/content/hosting-and-deployment/deployment-with-wercker.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [wercker,deployment,github,git] authors: [Arjen Schwarz, Samuel Debruyn] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 60 weight: 60 sections_weight: 60 @@ -345,4 +345,4 @@ If you want to see an example of how you can deploy to S3 instead of GitHub page [hugoconfig]: /getting-started/configuration/ [publicappurl]: https://app.wercker.com/#applications/5586dcbdaf7de9c51b02b0d5 [quickstart]: /getting-started/quick-start/ -[werckerdocs]: http://devcenter.wercker.com/docs/deploy/s3.html \ No newline at end of file +[werckerdocs]: http://devcenter.wercker.com/docs/deploy/s3.html diff --git a/content/hosting-and-deployment/hosting-on-bitbucket.md b/content/hosting-and-deployment/hosting-on-bitbucket.md index d7ea27a2e..f76fc4868 100644 --- a/content/hosting-and-deployment/hosting-on-bitbucket.md +++ b/content/hosting-and-deployment/hosting-on-bitbucket.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [hosting,bitbucket,deployment,aerobatic] authors: [Jason Gowans] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 50 weight: 50 sections_weight: 50 @@ -140,4 +140,4 @@ At this point, you can now create and edit blog posts directly in the Bitbucket ## Suggested next steps -The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site. \ No newline at end of file +The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site. diff --git a/content/hosting-and-deployment/hosting-on-firebase.md b/content/hosting-and-deployment/hosting-on-firebase.md index 289e125f4..7ba8319c5 100644 --- a/content/hosting-and-deployment/hosting-on-firebase.md +++ b/content/hosting-and-deployment/hosting-on-firebase.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [hosting,firebase] authors: [Michel Racic] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 20 weight: 20 sections_weight: 20 diff --git a/content/hosting-and-deployment/hosting-on-github.md b/content/hosting-and-deployment/hosting-on-github.md index a4131e2a2..78fccb2ee 100644 --- a/content/hosting-and-deployment/hosting-on-github.md +++ b/content/hosting-and-deployment/hosting-on-github.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [github,git,deployment,hosting] authors: [Spencer Lyon, Gunnar Morling] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 30 weight: 30 sections_weight: 30 @@ -241,4 +241,4 @@ Refer to the [official documentation for custom domains][domains] for further in [orphan branch]: https://git-scm.com/docs/git-checkout/#git-checkout---orphanltnewbranchgt [Quick Start]: /getting-started/quick-start/ [submodule]: https://github.com/blog/2104-working-with-submodules -[worktree feature]: https://git-scm.com/docs/git-worktree \ No newline at end of file +[worktree feature]: https://git-scm.com/docs/git-worktree diff --git a/content/hosting-and-deployment/hosting-on-gitlab.md b/content/hosting-and-deployment/hosting-on-gitlab.md index c61ff904b..ddf0190d5 100644 --- a/content/hosting-and-deployment/hosting-on-gitlab.md +++ b/content/hosting-and-deployment/hosting-on-gitlab.md @@ -9,8 +9,8 @@ categories: [hosting and deployment] tags: [hosting,deployment,git,gitlab] authors: [Riku-Pekka Silvola] menu: - main: - parent: "Hosting and Deployment" + docs: + parent: "hosting-and-deployment" weight: 40 weight: 40 sections_weight: 40 @@ -80,4 +80,4 @@ After the build has passed, your new website is available at `https:// - \ No newline at end of file + diff --git a/content/troubleshooting/eof-error.md b/content/troubleshooting/eof-error.md index 61f83d4b4..308904d06 100644 --- a/content/troubleshooting/eof-error.md +++ b/content/troubleshooting/eof-error.md @@ -6,6 +6,9 @@ date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 categories: [troubleshooting] +menu: + docs: + parent: "troubleshooting" tags: [eof, end of file, error, faqs] draft: false weight: diff --git a/content/variables/_index.md b/content/variables/_index.md index e868b270d..f34135f79 100644 --- a/content/variables/_index.md +++ b/content/variables/_index.md @@ -1,6 +1,6 @@ --- title: Variables and Params -linktitle: Overview +linktitle: Variables description: Page-, file-, taxonomy-, and site-level variables and parameters available in templates. date: 2017-02-01 publishdate: 2017-02-01 @@ -9,10 +9,10 @@ categories: [variables and params] tags: [variables,params,values,globals] draft: false menu: - main: - parent: "Variables" - weight: 01 -weight: 01 + docs: + parent: "variables" + weight: 1 +weight: 01 #rem sections_weight: 01 aliases: [/templates/variables/] toc: false @@ -20,4 +20,4 @@ toc: false Hugo's templates are context aware and make a large number of values available to you as you're creating views for your website. -[Go templates]: /templates/introduction/ "Understand context in Go templates by learning the language's fundamental templating functions." \ No newline at end of file +[Go templates]: /templates/introduction/ "Understand context in Go templates by learning the language's fundamental templating functions." diff --git a/content/variables/files.md b/content/variables/files.md index fddf8b711..7aa197c43 100644 --- a/content/variables/files.md +++ b/content/variables/files.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [files] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 40 weight: 40 sections_weight: 40 diff --git a/content/variables/git.md b/content/variables/git.md index 3eab4e331..967af8c2b 100644 --- a/content/variables/git.md +++ b/content/variables/git.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [git] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 70 weight: 70 sections_weight: 70 diff --git a/content/variables/hugo.md b/content/variables/hugo.md index 7ce766d71..e508d7d06 100644 --- a/content/variables/hugo.md +++ b/content/variables/hugo.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [hugo,generator] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 60 weight: 60 sections_weight: 60 diff --git a/content/variables/menus.md b/content/variables/menus.md index 497fd204d..7845654e0 100644 --- a/content/variables/menus.md +++ b/content/variables/menus.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [menus] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 50 weight: 50 sections_weight: 50 diff --git a/content/variables/page.md b/content/variables/page.md index d6a701450..7a074c664 100644 --- a/content/variables/page.md +++ b/content/variables/page.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [pages] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 20 weight: 20 sections_weight: 20 diff --git a/content/variables/shortcodes.md b/content/variables/shortcodes.md index 750d1a2a2..867ab8888 100644 --- a/content/variables/shortcodes.md +++ b/content/variables/shortcodes.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [shortcodes] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 20 weight: 20 sections_weight: 20 diff --git a/content/variables/site.md b/content/variables/site.md index 11d59f507..47358e26f 100644 --- a/content/variables/site.md +++ b/content/variables/site.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [global,site] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 10 weight: 10 sections_weight: 10 diff --git a/content/variables/sitemap.md b/content/variables/sitemap.md index b4190dacd..5155c931d 100644 --- a/content/variables/sitemap.md +++ b/content/variables/sitemap.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [sitemap] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 80 weight: 80 sections_weight: 80 diff --git a/content/variables/taxonomy.md b/content/variables/taxonomy.md index 176e4d2ef..4e30f2220 100644 --- a/content/variables/taxonomy.md +++ b/content/variables/taxonomy.md @@ -9,8 +9,8 @@ categories: [variables and params] tags: [taxonomies,terms] draft: false menu: - main: - parent: "Variables" + docs: + parent: "variables" weight: 30 weight: 30 sections_weight: 30 diff --git a/data/docsnav.yaml b/data/docsnav.yaml new file mode 100644 index 000000000..c0eeb5c49 --- /dev/null +++ b/data/docsnav.yaml @@ -0,0 +1,105 @@ +about: + order: 1 + title: "About Hugo" + url: "about" + haschildren: true + sortsubpagesby: "weight" + desc: "Hugo's features, roadmap, and license, as well as the motivation behind creating Hugo" +gettingstarted: + order: 2 + title: "Getting Started" + url: "getting-started" + haschildren: true + sortsubpagesby: "weight" + desc: "Quick start, cross-platform installation, configuration, basic usage, and directory structure" +contentmanagement: + order: 3 + title: "Content Management" + url: "content-management" + haschildren: true + sortsubpagesby: "weight" + desc: "Summaries, shortcodes, archetypes, permalinks, front matter, and supported content formats" +templates: + order: 4 + title: "Templates" + url: "templates" + haschildren: true + sortsubpagesby: "weight" + desc: "Pagination, homepage, rss, sitemap, lookup order, and data templates" +functions: + order: 5 + title: "Functions" + url: "functions" + haschildren: false + sortsubpagesby: "title" + desc: "Comprehensive list of Hugo templating functions, including basic and advanced usage examples" +variables: + order: 6 + title: "Variables" + url: "variables" + haschildren: true + sortsubpagesby: "weight" + desc: "Page-, file-, taxonomy-, and site-level variables and parameters available in templates" +themes: + order: 7 + title: "Themes" + url: "themes" + haschildren: true + sortsubpagesby: "weight" + desc: "Install, use, and create your own Hugo themes" +hostinganddeployment: + order: 8 + title: "Hosting and Deployment" + url: "hosting-and-deployment" + haschildren: true + sortsubpagesby: "weight" + desc: "Site builds, automated deployments, and popular hosting solutions, as explained by the Hugo community" +# tutorials: +# order: 9 +# title: "Tutorials" +# url: "tutorials" +# haschildren: true +# sortsubpagesby: "weight" +# desc: "Community-aggregated articles and code examples for approaching different projects with Hugo" +tools: + order: 10 + title: "Developer Tools" + url: "tools" + haschildren: true + sortsubpagesby: "weight" + desc: "Syntax highlighting, site search, text editor plug-ins, and migration tools" +commands: + order: 11 + title: "Command Line Reference" + url: "commands" + haschildren: false + sortsubpagesby: "" + desc: "Hugo's easy-to-use but extensive command line interface" +troubleshooting: + order: 12 + title: "Troubleshooting" + url: "troubleshooting" + haschildren: true + sortsubpagesby: "weight" + desc: "Known issues and workarounds, as well as FAQs pulled from the Hugo discussion forum" +news: + order: 13 + title: "News" + url: "news" + haschildren: true + sortsubpagesby: "weight" + desc: "Articles featuring Hugo, as well as updates and release notes for the project" +siteshowcase: + order: 14 + title: "Site Showcase" + url: "showcase" + haschildren: false + sortsubpagesby: "weight" + desc: "A collection of websites built using Hugo" +contributetohugo: + order: 15 + title: "Contribute to Hugo" + url: "contribute" + haschildren: true + sortsubpagesby: "weight" + desc: "Contribute to Hugo development and documentation" diff --git a/layouts/_default/list.html b/layouts/_default/list.html new file mode 100644 index 000000000..6a930406d --- /dev/null +++ b/layouts/_default/list.html @@ -0,0 +1,6 @@ +{{/* {{ define "header" }}{{ partial "page-header" . }}{{ end }} */}} +{{ define "main" }} + {{ $section_to_display := .Paginator.Pages }} + {{ $.Scratch.Add "section_to_display" $section_to_display }} + {{ partial "pagelayout.html" . }} +{{ end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html new file mode 100644 index 000000000..1174bcb39 --- /dev/null +++ b/layouts/_default/single.html @@ -0,0 +1,37 @@ +{{/* */}} + +{{ define "main" }} +
+
+ +
+ {{- partial "toc.html" . -}} +
+ +
+
+
+
+ {{ .Render "page" }} +
+
+
+ {{ partial "nav-links-docs.html" . }} +
+ +
+
+ +
+
+ {{ partial "docs/page-meta-data.html" . }} + {{ partial "page-edit.html" . }} + {{ partial "tags.html" . }} +
+
+ +
+ {{- partial "previous-next-links" . -}} +
+ +{{ end }} diff --git a/layouts/_default/taxonomy.html b/layouts/_default/taxonomy.html new file mode 100644 index 000000000..2c8b8d97d --- /dev/null +++ b/layouts/_default/taxonomy.html @@ -0,0 +1,6 @@ +{{/* {{ define "header" }}{{ partial "page-header" . }}{{ end }} */}} +{{ define "main" }} + {{ $section_to_display := .Data.Pages }} + {{ $.Scratch.Add "section_to_display" $section_to_display }} + {{ partial "pagelayout.html" . }} +{{ end }} diff --git a/layouts/_default/terms.html b/layouts/_default/terms.html new file mode 100644 index 000000000..28795cf44 --- /dev/null +++ b/layouts/_default/terms.html @@ -0,0 +1,49 @@ +{{/* {{ define "header" }}{{ partial "page-header" . }}{{ end }} */}} +{{ define "main" }} +{{ $section_to_display := .Data.Pages }} +
+ +
+
+ {{ partial "nav-links-docs.html" . }} +
+ +
+
+

+ {{ .Title }} +

+
+
+ {{ range $key, $value := .Data.Terms }} +
+

+ + {{ $key }} ↗ + +

+ {{ range $value.Pages }} +

+ + {{ .Title }} + +

+ {{ end }} +
+ + {{ end }} + +
+ + + + +
+ +
+ + + + +
+{{ end }} diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 000000000..08c28a1aa --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,6 @@ +{{/* {{ define "header" }}{{ partial "page-header" . }}{{ end }} */}} +{{ define "main" }} +{{ $section_to_display := (.Site.Taxonomies.tags.fundamentals).Pages }} +{{ $.Scratch.Add "section_to_display" $section_to_display }} + {{ partial "pagelayout.html" . }} +{{ end }} diff --git a/themes/gohugo-theme b/themes/gohugo-theme new file mode 160000 index 000000000..37131435f --- /dev/null +++ b/themes/gohugo-theme @@ -0,0 +1 @@ +Subproject commit 37131435ffa6fb7f8b1b340da3620cbc95e9afb9