A fast and flexible static site generator built with love by bep, spf13, and friends in Go.
This is the repository for the Hugo documentation site.
Please see the contributing section for guidelines, examples, and process.
The source for https://gohugo.io/
License: Apache License 2.0
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 🎉
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!!
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
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.
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:
Once this is merged: gohugoio/hugo#3645
We have eq
documented, but none of the other operators.
https://discourse.gohugo.io/t/how-to-check-if-variable-is-a-negative-number/7595
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.
Explaing the usage of govendor to vendor dependencies.
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
Pygments
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.
https://gohugo.io/functions/countwords/ currently redirects to https://gohugo.io/functions/countrunes/
Is this intentional?
At the mobile terminal,when you slide down the menu,it quickly disappears.
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
.
There seem to be some unusded CSS etc. Probably due to a imperfect merge.
The getJSON and getCSV functions should be documented in the Functions section, not just on the Data Templates page.
See gohugoio/hugo#3720 for context.
The code highlighting, esp. for the custom golang language definition, looks like crap, and should be fixed as soon as possible.
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).
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.
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:
/hugoSites
/hugoDocs
/hugoThemesSite
/gohugoioTheme
Make gohugoioTheme into a Git subtree and do two-way merges
Keep it as is.
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
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?
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>
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:
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).
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.
Many of the articles have the same title, such as "June Release." We should change these to "Hugo 0.24.1 Release" or something.
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
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
.
We're going to do a merge/update job to a brand new docs site. Stay tuned.
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
https://github.com/gohugoio/hugoDocs/tree/master/layouts/shortcodes being one recent example.
When removing one of them, please make sure you keep the most recent.
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/
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".
See forum discussion:
https://discourse.gohugo.io/t/make-url-use-only-ascii-characters/7592
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.