Commit graph

113 commits

Author SHA1 Message Date
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