Commit graph

179 commits

Author SHA1 Message Date
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
spf13
f78e2cb854 Removing Twitter js 2014-01-10 21:27:32 -05:00
spf13
a70acd110e New Icon Font for Hugo 2014-01-10 21:27:32 -05:00
spf13
dd574628a0 Adding community section to the documentation 2013-12-10 22:34:13 -05:00
spf13
ceb708052a Adding selected tweets to the homepage 2013-12-10 22:34:13 -05:00
spf13
532e2e7b93 Some mobile and other fixes for docs 2013-11-09 01:16:34 -05:00
spf13
861472bea5 Small tweaks to Homepage and CSS 2013-10-31 09:51:42 -04:00
spf13
1d0d280e20 Addition of an indexes section to the docs. Updated most of the existing index content. 2013-10-31 09:51:13 -04:00
spf13
90355eec79 Big visual overhaul of the docs. Docs now using indexes for all menu generation. 2013-10-26 02:18:14 -04:00
spf13
5003f7f7af Docs menu now powered by indexes.. converting some of the content to use this. 2013-10-25 18:42:46 -04:00
spf13
764abd2067 Update homepage 2013-10-24 16:49:17 -07:00
spf13
dde965a5cd Migrate docs to Bootstrap 3.0 2013-10-24 16:49:01 -07:00
spf13
678ddef46a Adding a quick start guide to hugo docs 2013-10-17 22:53:04 -04:00
spf13
4d333e81ee New Homepage for Hugo 2013-10-17 22:52:28 -04:00
Noah Campbell
895638433e Adding back the hugo homepage.
Deleted the page accidentially
2013-10-08 18:44:15 +02:00
Noah Campbell
9500ec1b6b Refactor layout selection code
The render code path would use a fallback if there was an exception.
This change instead relies on explicit declaration of the layout to use
and includes a check to see if the layout indeed exists before
attempting to render it.
2013-10-08 18:44:15 +02:00
Noah Campbell
197aacb647 Add support for Relative Permalinks 2013-10-08 18:42:03 +02:00
spf13
0a79edd48a Removing extra links on homepage 2013-08-17 21:54:39 -04:00
spf13
3ae8078d3a Adding "fork me on github" banner 2013-08-17 21:54:39 -04:00
spf13
8c0ab4def1 Complete overhaul of the docs 2013-08-17 21:54:39 -04:00
spf13
d5518c0966 Adding support for aliases (redirects) 2013-08-10 15:35:34 +01:00
Ross Lawley
e2a28114d1 Add redirect to page parameters and redirects example 2013-08-09 21:57:22 +01:00
spf13
de9f9ae16e Fixing getting started link. 2013-08-05 11:12:39 +02:00
spf13
f6e590e536 Fixing link to contributor page on github 2013-08-03 03:33:39 -04:00
spf13
6efbd93a38 Updating a bunch of the docs 2013-08-03 03:30:34 -04:00
spf13
def5f10183 Including documentation on indexes 2013-08-03 03:29:49 -04:00
spf13
8fae5f0dd6 Default is now pretty urls (without .html)
Adding --uglyurls option to retain previous behavior
2013-07-19 00:10:42 -07:00
spf13
f199004989 GO -> Go 2013-07-15 17:44:51 -07:00
spf13
6e16449e5f adding hugo 2013-07-04 11:32:55 -04:00