github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
The world’s fastest framework for building websites.
7 commits 141 branches 301 tags 201 MiB
Go 95.9%
JavaScript 3.1%
HTML 0.9%
Find a file
Bjørn Erik Pedersen 61c27b58b3 Squashed 'docs/' changes from 1662b9d0..20959c7b 
20959c7b Rewrite the syntax highlighter docs etc.
92435459 Add a note about branches
REVERT: 1662b9d0 Add missing Disqus links in templates/internal.md

git-subtree-dir: docs
git-subtree-split: 20959c7b9124341dfc4d139748244818b9cb3641
2017-09-25 09:02:42 +02:00
archetypes Squashed 'docs/' changes from 44fe0285..32356e4e 2017-09-21 19:03:00 +02:00
content Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
data Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
layouts/shortcodes Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
src/css Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
static Squashed 'docs/' changes from 44fe0285..32356e4e 2017-09-21 19:03:00 +02:00
themes/gohugoioTheme Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
.gitignore Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
.gitmodules Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
config.toml Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
LICENSE.md Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
netlify.toml Squashed 'docs/' changes from 44fe0285..32356e4e 2017-09-21 19:03:00 +02:00
pull-theme.sh Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
README.md Squashed 'docs/' changes from 1662b9d0..20959c7b 2017-09-25 09:02:42 +02:00
requirements.txt Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00

README.md

Hugo Docs

Documentation site for Hugo, the very fast and flexible static site generator built with love in GoLang.

Contributing

We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our contribution guide. We would love to hear from you.

Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the hugo repository.

Pull requests shall only contain changes to the actual documentation. However, changes on the code base of Hugo and the documentation shall be a single, atomic pull request in the hugo repository.

Branches

  • The master branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
  • The next branch is where we store changes that is related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/

Build

To view the documentation site locally, you need to clone this repository:

git clone https://github.com/gohugoio/hugoDocs.git

Also note that the documentation version for a given version of Hugo can also be found in the /docs sub-folder of the Hugo source repository.

Then to view the docs in your browser, run Hugo and open up the link:

▶ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop