Commit graph

178 commits

Author SHA1 Message Date
Albert Nigmatzianov
99412bfe45 docs: Delete brew update from docs
Fix #3518
2017-05-25 13:31:38 +02:00
Bjørn Erik Pedersen
7f6430d84d Automate the Hugo release process
This commit adds a work flow aroung GoReleaser to get the Hugo release process automated and more uniform:

* It can be run fully automated or in two steps to allow for manual edits of the relase notes.
* It supports both patch and full releases.
* It fetches author, issue, repo info. etc. for the release notes from GitHub.
* The file names produced are mainly the same as before, but we no use tar.gz as archive for all Unix versions.
* There isn't a fully automated CI setup in place yet, but the release tag is marked in the commit message with "[ci deploy]"

Fixes #3358
2017-04-24 11:08:56 +02:00
Bjørn Erik Pedersen
86a97dbd18 docs: Add Netlify badge if on Netlify 2017-04-14 10:22:51 +02:00
Bjørn Erik Pedersen
03ec2b3397 docs: AddHugo 0.20 Release Notes 2017-04-10 09:07:01 +02:00
Bjørn Erik Pedersen
3c405f5172 all: Document the Output Formats feature
This commit also adds a new command, docshelper, with some utility funcs that adds a JSON datafiles to /docs/data that would be a pain to create and maintain by hand.

Fixes #3242
2017-04-07 10:52:16 +02:00
Mark D. Blackwell
4b9493cb03 docs: Improve command reference page 2017-03-13 12:40:19 +01:00
digitalcraftsman
e9921ae4b2 docs: Mention Hugo's official twitter account 2017-02-23 22:05:38 +01:00
Bjørn Erik Pedersen
0dad69325d docs: Vanity-update of site meta description 2017-01-05 01:40:00 +01:00
Cameron Moore
6a51216c6a docs: Don't use binary version in docs site
Adds a "release" Site param that will be need to be updated for each
release.

Fixes #2857
2017-01-02 14:08:36 +01:00
Bjørn Erik Pedersen
a60ec06383 docs: Replace .Now with now 2017-01-01 23:54:19 +01:00
Bjørn Erik Pedersen
ae1de7abb1 docs: Make the tools content page a section page
Because it is the right solution and it the avoids naming conflict with section vs page.

Updates #2297
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
1eb3c4a8e7 docs: Fix list template link 2016-11-22 00:37:10 +01:00
Bjørn Erik Pedersen
3031793431 docs: Add a simple list template
Fixes #2710
2016-11-20 15:37:18 +01:00
digitalcraftsman
ec44ad5c0b docs: Link latest change as commit in the footer 2016-11-04 19:12:17 +01:00
Bjørn Erik Pedersen
e8380e612f Add GitInfo
This commit adds a `GitInfo` object to `Page` if `EnableGitInfo` is set.

It then also sets `Lastmod` for the given `Page` to the author date provided by Git.

The Git integrations should be fairly performant, but it adds "some time" to the build, somewhat depending on the Git history size.

If you want, you can run without during development and turn it on when deploying to the live server: `hugo --enableGitInfo`.

Fixes #2102
2016-11-01 23:04:12 +01:00
Bjørn Erik Pedersen
c2bf748ec5 docs: Refactor /docs to use the block keyword
Fixes #2226
2016-10-09 11:20:46 +02:00
Mark D. Blackwell
88ec7d88d1 docs: Improve home page
Organize CSS and Javascript files into directories, separating vendor
source code from home-grown.

Separate new properties and selectors in Bootstrap CSS (already edited
for Hugo) from:
1. Original property values; and
2. Changed property values.

For the home page:

1. Clarify the English text;
2. Add some element names to classes in CSS selectors (to speed loading);
3. Document the Owl Carousel and Highlight.js versions;
4. Add Owl Carousel's license;
5. Restore HTML comments to browser source views;
6. Make the beginning GitHub button transparent on focus (like the others);

7. For the final, colored Twitter and Github buttons:
  a. Remove the dotted box on focus; and
  b. Color them green on active.

8. To increase (layout/) source readability:
  a. Place `class` attributes before `href` attributes;
  b. In `class` attributes, place more-specific class names before
     less-specific; and
  c. Comment the beginnings and ends of Bootstrap rows.

9. To increase understandability during development:
  a. Document the meaning of CSS file, `HPstyles` by renaming it to
     `home-page-style`;
  b. Move inline styling to CSS stylesheets;
  c. Separate @media queries to a file;
  d. Separate the inline Owl Carousel custom Javascript to a file;
  e. Use regular Owl Carousel CSS files instead of minified ones; and
  f. Rename the wide, landscape desk background image filename from
     `desk-long` to `desk-wide`.
2016-10-01 22:19:22 -04:00
Mark D. Blackwell
83533a8881 docs: Improve Overview Configuration manual 2016-09-17 21:29:37 -04:00
Mark D. Blackwell
0d1e96701f docs: Improve Traversing Local Files 2016-09-15 15:15:04 +02:00
Bjørn Erik Pedersen
318558f26c docs: Add 404 template
Closes #1965
2016-07-14 00:01:06 +02:00
Bjørn Erik Pedersen
ca5ae50c2b Revert "docs: Refactor /docs to use the block keyword"
I forgot that we support Go 1.5 ...

This reverts commit 3a2748e0d2.
2016-06-20 17:53:27 +02:00
Bjørn Erik Pedersen
3a2748e0d2 docs: Refactor /docs to use the block keyword
Fixes #2226
Closes #2229
2016-06-20 15:50:41 +02:00
digitalcraftsman
48fce6110d docs: Move Algolia styling into style.css 2016-04-22 18:18:50 +02:00
Bjørn Erik Pedersen
ef933e4a7f docs: Limit the quotes on front page to the last two years
We should get some new ones in there.

Also shuffle the order. This also means no merging into 0.15-docs ...

Which also means we should get a release out there ... soon!

See #2055

Also See https://github.com/BurntSushi/toml/issues/129 for an explanation to the little bit ugly dates.
2016-04-07 23:46:46 +02:00
Robert Basic
40f62a863c docs: Use data folder for website carousel
Fixes #2055
2016-04-07 22:50:38 +02:00
digitalcraftsman
8890885a70 docs: Add search form powered by Algolia 2016-03-25 11:22:01 +01:00
Cameron Moore
f52b040ee1 docs: Draft of 0.16 release notes
Also included is an enhancement to the gh shortcode to support sending commit
hashes by prepending "0x" to the hash.
2016-03-21 14:08:39 +01:00
digitalcraftsman
cfbae7cea2 docs: Add guideline for showcase additions 2016-02-13 10:05:08 +08:00
digitalcraftsman
b47652fb29 Docs: add panel showing the last revision of a page
The panel also contains the version of the
documentation.
2016-01-07 04:23:26 -07:00
Anthony Fok
6a23cd65e1 Docs: Update copyright year on gohugo.io front page 2016-01-04 23:47:12 -07:00
Anthony Fok
851c16ef3b Docs: Run "brew update" before "brew install hugo"
Remind user to always run "brew update" first in order to avoid
repeated bug reports from users who didn't do that.

See #824, #1067, #1537, #1633 and #1749
2016-01-04 23:36:57 -07:00
Anthony Fok
cb8f459127 Docs: Add nohighlight shortcode and improve formatting
And some random formatting and copyediting fixes.

See also #1708
2015-12-23 09:31:07 -07:00
Anthony Fok
7cf7f85ad6 Docs: Upgrade highlight.js to 9.0.0
with the following added languages in anticipation of document expansion:

    apache dockerfile dos less php powershell python tex yaml

To reproduce docs/static/js/highlight.pack.js on Debian/Ubuntu:

    $ sudo apt-get install nodejs npm
    $ wget https://github.com/isagalaev/highlight.js/archive/9.0.0.tar.gz
    $ tar xzf 9.0.0.tar.gz
    $ cd highlight.js-9.0.0/
    $ npm install
    $ nodejs tools/build.js markdown asciidoc xml css javascript \
      ini yaml json go bash diff dockerfile dos powershell makefile \
      apache nginx tex http php python ruby django haml handlebars \
      scss less coffeescript

Then, copy the resulting build/highlight.pack.js as well as
src/styles/monokai-sublime.css to the appropriate Hugo docs directories.
2015-12-22 13:54:35 -07:00
Anthony Fok
23abad7b1d Docs: Upgrade Owl Carousel to 2.0.0-beta.3 (2015-06-19)
Downloaded from
http://smashingboxes.github.io/OwlCarousel2/download/owl.carousel.2.0.0-beta.3.zip

Also modify /index.html to use minified version of CSS files.
2015-12-21 13:21:42 -07:00
Anthony Fok
883431442d Docs: Rename bootstrap-theme.css to bootstrap-gohugo.css
because our bootstrap-theme.css was originally a customized
core bootstrap.css file from Bootstrap v3.0.0.

This rename helps to avoid confusion with Bootstrap’s official
bootstrap-theme.css files.
2015-12-21 12:04:11 -07:00
Anthony Fok
7c84ad56cb Docs: Remove unused GitHub:buttons files
The GitHub:buttons JavaScript code docs/static/js/buttons.js
from https://github.com/ntkme/github-buttons was referenced
in docs/layouts/partials/footer.html but never used.

Apparently, the actual code for the GitHub buttons on the upper-left
corner of gohugo.io documentation was written by @spf13 in
docs/static/js/scripts.js.
2015-12-20 13:18:18 -07:00
Anthony Fok
a84d82121a Upgrade jQuery 2.1.1 to 2.1.4 in doc 2015-12-19 12:19:26 -07:00
Anthony Fok
f24ffc9c3d Docs: Allow HTML in Showcase titles
This allows, for example, marking with the lang attribute
so that the correct CJK glyph variants are displayed.
2015-12-19 06:15:08 -07:00
Anthony Fok
f363faadab Add a number sign "#" before a GitHub issue number
to make it more readily recognizable.
2015-12-02 13:11:24 -07:00
Cameron Moore
6812229bb8 Add gh shortcode to docs site
The `gh` shortcode has two modes: users and issues.  For user mode, pass a list
of `@username` arguments.  For the issues/PR mode, pass a list of issue or PR
numbers.  PRs link to the "issues/" URL since Github redirects to the correct
URL.

Thanks to @ryanclarke for suggesting an improved template.
2015-12-02 12:18:04 -07:00
Anthony Fok
acd720df92 Add docs/data/titles.toml to set title "Site Showcase"
Idea from https://discuss.gohugo.io/t/how-to-name-list-templates/949
2015-11-16 06:48:20 -07:00
Diego Medina
ddd8c77938 Use https
The Hugo site uses HTTPS but the video link was HTTP, which made chrome block the video
2015-10-12 13:38:33 -06:00
Anthony Fok
08d41c3a48 Fix strange carousel width on http://gohugo.io/
The solution is to add `table-layout:fixed` when `display:table` is used
as per the answer given at:

    http://stackoverflow.com/questions/21230184/owl-carousel-inside-a-table-cell-parent-makes-parent-to-expand-weird

Fixes #1465
2015-10-02 03:32:33 -06:00
spf13
bfa06fff86 showcase layout improved when thumbnails are different proportions 2015-09-08 11:23:14 -04:00
Anthony Fok
36b374f8ab docs: Add site title; set pluralizeListTitles = false
To prevent "Showcase" from becoming "Showcases",
also to have the RSS feed display correct titles,
i.e. "Showcase on gohugo.io" rather than "Showcase on ".
2015-08-08 01:41:18 -06:00
Bjørn Erik Pedersen
2805a6f80e Also rename readDir in docs shortcode 2015-08-07 14:55:53 +02:00
Anthony Fok
5505ac0d72 doc: Strip trailing whitespace; other revisions
Make some random and non-comprehensive changes to the
template functions documentation to make them more
consistent.
2015-08-04 12:00:08 -06:00
Russell Oliver
81e69c416d Add ReadDir function to list local files.
Includes documentation.
2015-07-25 21:56:38 +02:00
Éli Marshal
90af334c21 Omit protocol from embedded font resources
Fixes the mixed content errors and loads fonts when accessing
https://gohugo.io/
2015-07-11 01:10:45 +02:00
bep
599d1b9786 Add gendoc command
Using the new, great auto-doc in Cobra.

This commit also contains a current result of that command added to a commands section in docs.

Fixes #1136
2015-05-19 10:57:21 -04:00
bep
be72f234f8 docs: Use ToC length to pick the compact version 2015-05-11 22:23:35 +02:00
bep
be4f48652d Add ToC to long pages
* A compact, fixed box in the right screen
* Only for big screens, > 1200 px wide
2015-05-11 18:39:42 +02:00
Anthony Fok
b3bd71fec9 Update Hugo docs with the initialisms suggested by golint
In particular:

 * .Url → .URL (for node, menu and paginator)
 * .Site.BaseUrl → .Site.BaseURL
 * getJson → getJSON
 * getCsv → getCSV
 * safeHtml → safeHTML
 * safeCss → safeCSS
 * safeUrl → safeURL

Continued effort in fixing #959.
2015-03-18 11:30:37 +01:00
Anthony Fok
63e7b9705f [Docs] Add pointers to roadmap; new tweet and article 2015-02-16 09:02:56 -07:00
Anthony Fok
ba44e860a3 [Docs] Copyediting
* Add meta author, description and generator tags
 * Add Hugo version beside the logo and in the footer
 * Suggest the user to run `go get -u -v` to update dependencies
 * Requires Go 1.3+ rather than Go 1.1+
 * Improve rendering/formatting in some places
 * Add trailing slash to URLs where appropriate
 * GitHub redirects all http requests to https, update accordingly
2015-01-28 18:02:40 -07:00
Dan Hersam
06b1a88358 Added three videos to documentation.
Created shortcode for YouTube videos and made the videos responsive in the
stylesheet.
2015-01-27 23:44:46 +01:00
Anthony Fok
4609f77a80 [Docs] New testimonials and press coverage
Found on @spf13's Twitter.  :-)

Prevent the testimonial dates from wrapping.

Also fix a few minor problems to get the home page
to validate as proper HTML5.
2015-01-19 04:16:54 -07:00
Anthony Fok
b56c9db6dc [Docs] Add FreeBSD logo beside the FreeBSD name
Extracted from https://www.freebsd.org/logo/logo-simple.svg
for temporary use until a future Font Awesome release adds
the `fa-freebsd` glyph (github/FortAwesome/Font-Awesome#1116)  :-)

Make .fa `display: inline` to prevent unwanted line-wrapping

Also make the menu item "Issue & Help" line up with the others.
2015-01-19 02:48:44 -07:00
Anthony Fok
32d15d91fc Change CR+LF to LF on gohugo.io front page, saving 286 bytes
Also change mode 100755 to 100644.
2015-01-17 13:24:35 -07:00
Anthony Fok
af956c41a3 Update gohugo.io front page for 2015; add @popthestack's testimony :-) 2015-01-17 13:07:54 -07:00
Anthony Fok
b0181e278b Some more random copyediting of Hugo docs
- Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.
2015-01-09 11:51:15 -07:00
bep
cb909cde5a Google Custom Search: Open link in _parent 2015-01-08 13:42:16 +01:00
Anthony Fok
eba33459dd Add basic Google Custom Search to Hugo docs
Fixes #753
2015-01-08 00:17:01 -07:00
Anthony Fok
010f6057ff Correct URL of the favicon in the documentation
img/favicon.png does not seem to exist,
so follow the example in docs/layouts/index.html
and use /favicon.ico instead.
2014-12-08 22:34:00 +01:00
spf13
5dfc1dedb8 Big refactor of how source files are used. Also added default destination extension option. 2014-10-16 20:20:09 -04:00
Anthony Fok
ca7007bf26 Minor proofreading corrections to Hugo docs
- Add backticks and commas where necessary
- Remove some trailing whitespace
- Add front matter example in TOML
- Fix typo in one of the tags in Showcase
- Add 多说 (Duoshuo) as an alternative to Disqus
- Use internal links (i.e. without gohugo.io) where possible
- Use a colon to set off an example
- Change "it's" to "its" where appropriate
- Use typographical (i.e. curly) apostrophe on the front page
  where appropriate
- Capitalize "Github" as "GitHub"
2014-10-15 12:18:20 -04:00
spf13
b81ebf2ada Making the install on the homepage a bit more clear 2014-09-22 22:08:08 -04:00
Alex Dunn
4e4ea9583f instructions for Homebrew installation
updated installation page of documentation, and changed "Download" button on index.html to scroll to bottom where multiple installation options are featured

getting the scrolldown to work required removing the fixed positioning on #action and on the footer
2014-09-22 21:51:19 -04:00
spf13
d5308e6f6f Adding a community link to the homepage 2014-09-19 08:32:25 -04:00
Anthony Fok
5dd3eaabee More proofreading and minor revisions to Hugo docs
Among the various changes, most instances of

    {{ template "partials/FILE.html" . }}

were changed to

    {{ partial "FILE.html" . }}

Also, in main.go, change "2013" to "2013-14".
2014-09-08 11:41:10 -04:00
spf13
f36ed446cc Adding a bunch of new quotes to the front page and switching to Owl Carousel 2014-09-01 10:00:06 -04:00
Dato Simó
f142458c4b Use typographic quote chars in the carousel quotes section
At big font sizes, quotes really become more beautiful with them.
2014-08-30 23:19:22 -04:00
spf13
f5157566ef Cleaning up a ton of CSS.. Removing unused selectors. Eliminated over 80% of CSS. Upgrading jQuery & FA 2014-08-20 14:10:36 -04:00
spf13
34a93fa1f3 Fixing the docs sidebar interactions 2014-08-20 13:13:51 -04:00
spf13
e31d460909 Bringing back the showcase 2014-08-19 21:47:38 -04:00
spf13
b047e2f880 Removing redundant bootstrap 2014-08-19 21:46:27 -04:00
spf13
864f91d90e Changing the docs template partials to be able to be used to render a section 2014-08-19 21:28:37 -04:00
spf13
8d3fa7ef49 Getting rid of bad scrollbar 2014-06-30 23:41:53 -04:00
spf13
c297d7451f Adding 'partial' template function to add theme / local awareness to the partials directory. 2014-06-06 16:15:19 -04:00
spf13
a3d6e7c46f Fix docs script and css references to refer to the correct location 2014-05-29 18:45:21 -04:00
spf13
2a44ca543b More doc site improvements. Added documentation's new layout 2014-05-28 01:37:33 -04:00
spf13
df4bbcef30 Adding instant click library to docs so even more responsive navigation 2014-05-16 17:51:10 -04:00
spf13
be1ee22032 Proper integration of live reload with automatic injection 2014-05-16 17:49:27 -04:00
spf13
60ed5bda2b Live reloading is working! Still need to incorporate cleanly. 2014-05-16 11:48:59 -04:00
spf13
b520f8852d Switching docs highlighting to highlight.js .. Docs build super fast again! 2014-05-15 09:58:55 -04:00
spf13
a4a1e39a51 Fixing issue when two menu items have the same name. 2014-05-14 18:08:11 -04:00
spf13
ac82fe32af Making active parent in nav reflect when child is active page in docs 2014-04-24 10:34:50 -06:00
spf13
ef87dffb2f Fix accidentally removed line from menu template. 2014-04-24 10:28:11 -06:00
spf13
11fe227b9e Implementing new menu system in the docs site 2014-04-23 03:00:11 -04:00
Zach Chadwick
2e4158b0b4 added appliance.cloudshark.org to showcase
also cleaned up thumbnail view to not show source link if unavailable
2014-03-31 13:35:15 -04:00
Nate Finch
c02a02070f change golang to go 2014-03-24 14:34:41 -04:00
spf13
f733e70e80 Adding apple touch & favicon meta links 2014-03-24 14:32:03 -04:00
spf13
51b078a703 Homepage update. New Logo. Minor site updates. 2014-03-20 21:51:14 -04:00
Alexandre Normand
85c04ca2f3 Add Tutorial With Steps to Migrate from Jekyll. 2014-03-13 12:23:33 +01:00
spf13
8fe78f6ff5 A bunch of small documentation changes 2014-02-21 09:48:37 -05:00
spf13
18b9948f1e Using table of contents within the documentation. 2014-01-28 23:29:05 -05:00
spf13
4f1807c7a7 Replacing hall of fame with showcase. (new type, content driven, thumbnails, etc) 2014-01-22 17:16:09 -05:00
spf13
303be735fb Adding github button to docs homepage 2014-01-18 11:05:50 -05:00
spf13
13b5c10dd7 Rewriting some homepage text 2014-01-10 21:29:58 -05:00
spf13
74d7ae1f8f A bunch of style updates. Switching to bootstrap carousel. 2014-01-10 21:29:58 -05:00