gohugoio/hugodocs

The source for https://gohugo.io/

hugodocs's Issues

Document archetype templates

See gohugoio/hugo#3605

Functions should live in namespaces (sub-sections)

Document navigateToChanged

Once this is merged: gohugoio/hugo#3645

Add more context to Pygments errors

This isn't very helpful:

ERROR 2017/07/15 09:58:12 Error: no lexer for alias 'golang' found
ERROR 2017/07/15 09:58:12 Error: no lexer for alias 'toml' found
ERROR 2017/07/15 09:58:12 Error: no lexer for alias 'toml' found
ERROR 2017/07/15 09:58:12 Error: no lexer for alias 'toml' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'golang' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'git' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'toml' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'toml' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'markdown' found
ERROR 2017/07/15 09:58:13 Error: no lexer for alias 'golang' found

site-hierarchy.svg: taxonomy branch shows wrong values

In taxonomy tree on the right side the node on the left branch states Term 1; Lists 1,3,4,5 but has leaves 1, 3, 5, 6.

Fix doc for highlight func

I was going to use this myself, but did not get much help:

https://gohugo.io/functions/highlight/#readout

The below is probably a mistake, but this is what's needed:

{{ highlight .TheSourceCode  "html" "" }}

The last param is non-optional options.

Document removePathAccents in config list...

See forum discussion:

https://discourse.gohugo.io/t/make-url-use-only-ascii-characters/7592

QuickStart Guide - Step 8. Customize robust theme - "url(...)" not evaluating

I am following the docs current as of today (18 July 2017).

When the quickstart instructs to create layouts/_default/li.html and paste in code, the rendered result does not have a proper URL for the image.

I have an image in static/images/default.jpg as well as one in themes/hugo_theme_robust/static/images/.

---

<article class="li">
  <a href="{{ .Permalink }}" class="clearfix">
    <div class="image" style="background-image: url({{ $.Site.BaseURL }}images/{{ with .Params.image }}{{ . }}{{ else }}default.jpg{{ end }});"></div>
  </a>
</article>

Trim the tags usage

Started building sites ...
Built site for language en:
0 of 7 drafts rendered
0 future content
0 expired content
218 regular pages created
214 other pages created
2 non-page files copied
14 paginator pages created
15 categories created
180 tags created
total in 1083 ms

180 is way too much (and slows down the site build). Having so many tags is a misunderstanding of the taxonomy concept: These should be common concepts, not SEO keywords (use something else for that).

Use imperative mood in titles

This is a matter of taste, but to me, this looks heavy:

Taxonomy List Templates
Taxonomy Terms Template
WeightedPages
Ordering Taxonomies
Ordering Content within Taxonomies
Displaying a Single Piece of Content’s Taxonomies
Listing Content with the Same Taxonomy Term
Listing All content in a Given taxonomy
Rendering a Site’s Taxonomies
.Site.GetPage for Taxonomies

Compare that to the lighter:

Taxonomy List Templates
Taxonomy Terms Template
WeightedPages
Order Taxonomies
Order Content within Taxonomies
Display a Single Piece of Content’s Taxonomies
List Content with the Same Taxonomy Term
List All content in a Given taxonomy
Render a Site’s Taxonomies
.Site.GetPage for Taxonomies

Countwords documentation redirects to Countrunes

https://gohugo.io/functions/countwords/ currently redirects to https://gohugo.io/functions/countrunes/

Is this intentional?

Document cast.string and cast.int template funcs

News pages need better titles

URL: https://gohugo.io/news/

Many of the articles have the same title, such as "June Release." We should change these to "Hugo 0.24.1 Release" or something.

Document binary comparison operator functions

We have eq documented, but none of the other operators.

• ne
• lt
• le
• gt
• ge

https://discourse.gohugo.io/t/how-to-check-if-variable-is-a-negative-number/7595

Handle refs/relrefs starting with slash

hugoDocs is frozen for a few days / no changes to master

We're going to do a merge/update job to a brand new docs site. Stay tuned.

@rdwatters @digitalcraftsman

Fix code highlighting

The code highlighting, esp. for the custom golang language definition, looks like crap, and should be fixed as soon as possible.

Link RSS feeds

Currently, a lot of users will not note the presence of an RSS feed for certain sections in the docs. The news section is likely the most interesting one for users due to the release notes etc.

The RSS feed could be linked in the top right corner next to the Twitter icon or maybe somewhere in the footer.

Discussed in https://discourse.gohugo.io/t/rss-for-official-hugo-blog/7502/

Fix the go get install instructions

Explaing the usage of govendor to vendor dependencies.

Add *some* highlighting

OK, so we now have some syntax highlighting that looks consistent -- but there are some longish template examples that would benefit with some syntax colours.

I suggest we

1. Remove the language tag on all examples (search replace)
2. Enable Pygments
3. Add html on the selected few examples.

Pygments does a fairly good job with Go template code:

http://bepsays.com/2017/07/19/highlight-test/

There are probably also some other styles that will do even better.

/cc @budparr @moorereason @rdwatters

countrunes and countwords are set as aliases of each other

Both function pages have an alias line:

aliases: [/functions/countrunes/,/functions/countwords/]

I would have removed them, but maybe that is part of a plan? The current site is redirecting countwords to countrunes.

Update docs vs union and intersect

See gohugoio/hugo#3673

/cc @digitalcraftsman

scss or less files files?

Hi,

I'm trying to steal the hugodocs css (I think a lot of people are interested in that!) but would like to make a few changes to your bootstrap config, esp. to the colors. Do you have the source files for your bootstrap config? thank you!!

Update docs vs templates and language

See gohugoio/hugo#3670

Add LICENSE file

Previously, the spf13/hugo repo was all Apache 2.0. Now that it's been split up, it's probably best to copy the LICENSE file to all the new repositories as well.

Remove unused files below /static

There seem to be some unusded CSS etc. Probably due to a imperfect merge.

Remove unused "<i class="icon-linux"></i>" and similar

It is not used.

And for the future: Do not add stuff that we may or may not use some time. It adds maintainance (this issue is an example of that).

Duplicate shortcodes in hugoDocs vs theme

https://github.com/gohugoio/hugoDocs/tree/master/layouts/shortcodes being one recent example.

• It is kind of clumsy to have to edit to repos to make simple changes (makes PRs hard to do)
• But we can not maintain two versions of the same shortcode

When removing one of them, please make sure you keep the most recent.

Update the Copyright in the Docs Footer

no function pages for getJSON/getCSV

The getJSON and getCSV functions should be documented in the Functions section, not just on the Data Templates page.

Add contribution guidelines

It's basically the contribution guidelines in the main repo (hugo). It should explain the purpose of the three branches as well. My proposed model was:

• stable: only includes docs of released Hugo versions where the latest commit of a release is tagged with v0.xx
• master: used to build the current version of the hugo website. Can include new commits like typo fixes but that aren't present in stable
• dev: includes docs that can't go live yet, e.g. for upcoming features like the nested sections. Before a release this branch well be rebased with master. Now, master includes all new commits (typo fixes + docs for upcoming features). With each new release master gets merged into stable and the status quo will be tagged as v0.xx

Update docs vs nested sections

github_repo not set in config

The "File an issue" link in the footer currently doesn't work:
https://github.com/gohugoio/gohugoioTheme/blob/master/layouts/partials/site-footer.html#L22

Congrats for the new design, I like it a lot 🎉

Outdated docs for _index.md / _index.de.md for sections...

see topic...

https://gohugo.io/overview/source-directory#content-for-home-page-and-other-list-pages

with a _index.md I get an error:

ERROR 2017/07/05 17:47:22 error processing shortcode "_internal/shortcodes/relref.html" for page "index.zh-cn.md": template: _internal/shortcodes/relref.html:1:76: executing "_internal/shortcodes/relref.html" at <relref .Page (.Get 0...>: error calling relref: No page found with path or logical name "getting-started/index.md".

Move docs related archetypes from theme to this project

Document order for `.Lastmod` variable

Per conversations on Gitter and gohugoio/gohugoioTheme#44.

In new site structure, need to update content in the following locations:

• content/variables/git.md
• content/variables/page.md

Docs should explain differences in .Lastmod variable and its relationship to the enableGitInfo directive in site config.

Fix the <title> for single pages

Repeating the slogan for every page makes it stuttery.

Better to just do "Hugo | Content org..." etc. on the sub pages.

Merge next into master

https://github.com/gohugoio/hugoDocs/tree/next

"Hugo sites" vs theme

Right now we have two web sites sharing a theme as a submodule.

Which isn't too grand if you want to create a fix/feature/PR that has changes in both.

3 options, none perfect:

1. Hugo website mono repo

/hugoSites
   /hugoDocs
   /hugoThemesSite
   /gohugoioTheme

2. Make gohugoioTheme into a Git subtree and do two-way merges

3. Keep it as is.

problem of menu in mobile

At the mobile terminal,when you slide down the menu,it quickly disappears.

Correct explanation of index page rendering for Ugly URLs...

See gohugoio/hugo#3720 for context.

Double-check dates for release notes in news section

While adding the release notes to the documentation it might happen that I accidently used a wrong date, e.g. didn't changed the year from 2016 to 2017 while copying.

See https://twitter.com/JohnJbar/status/888383933443969024

Fix broken "quick start"

See https://discourse.gohugo.io/t/newbie-is-having-major-grief-with-quick-start/7552/2

Revisit Hugo contribution tutorial

A while ago (were we had 9000 stars on Github), I planed to write a tutorial about how users can contribute to Hugo. We should check for well the tutorial reflects the state.

Here's a list of things that should be improved:

• vendoring as introduced to manage dependencies but it's not even mentioned Looks like that's now updated - Editted by Kaushal
• some of the commands can be automated with the Makefile, e.g. the update of deps
• references and links still point to Steve's GH account They now point to gohugoio organization - Editted by Kaushal
• The code contribution guidelines should be linked to reference the our view of a good commit message
• (optional): some screenshot's could be updated

Fix formatting on CLI overview summary

The sections pull from cobra output and Markdown causes the lines to jumble together. Example:

hugo

hugo hugo builds your site Synopsis hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with 

Should look like

hugo

hugo hugo builds your site

Synopsis hugo is the main command, used to build your Hugo site.

Hugo is a Fast and Flexible Static Site Generator built with 

Add snap install for Ubuntu

The current documentation says to install hugo via apt. The version installed by apt is very old and does not work with the default theme.

https://gohugo.io/getting-started/installing/#i-class-icon-linux-i-linux

The snap version is up to date and works out of the box. So please update the documentation to install via the snap:

sudo snap install hugo

Document disableAliases setting

See gohugoio/hugo#3613

hugoDocs branch model

There seems to be some confusion about what branches to use for what, and I guess we have learned some lessons by living with this new setup for a little.

I would say that if the majority of the ongoing changes are relevant for the current release version of Hugo, then those changes should be pulled directly into master, and we should deploy from master.

But then we should get rid of stable, as stable would then be the tags.

So, given the current status:

• master: 0.24.1

• dev: 0.25-DEV

• hugo/docs (which is now a Git subtree): 0.25-DEV

• So most PRs in hugoDocs goes into master and directly live. Some changes will have to be pulled into dev and wait for a new release.

• Some PRs in hugo will contain docs-changes. I guess we'll merge those into dev at intervals (at least every release).

• On new release: Bump and tag master to new version 0.25, bump dev to 0-26-DEV.

So 2 branches.

Does that make more sense?

/cc @digitalcraftsman

Add "notes" types with colours

The above is from the Jekyll docs. We have the "notes" shortcode, which is blue, but I kind of whish we had some more -- at least one "pro tip" in another colour.

Oh... and those Jekyll background gradients looks nice ...

Increased rssLimit (from 15) is not reflected in docs

See gohugoio/hugo#3370