2014-04-12 16:04:17 -04:00
|
|
|
Hugo Example Blog
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
This repository provides a fully-working example of a [Hugo](https://github.com/spf13/hugo)-powered blog. Many
|
|
|
|
|
Hugo-specific features are used as a way to see them in action, and hopefully ease the learning curve for creating your
|
|
|
|
|
very own site with Hugo.
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- Recent Posts at main index
|
|
|
|
|
- Indexes for `tags` and `categories`
|
|
|
|
|
- Post information block, with links for all `tags` and `categories` post belongs to
|
|
|
|
|
- [Bootstrap 3](http://getbootstrap.com/) ready
|
2014-09-02 15:05:20 -04:00
|
|
|
- Currently using the [Yeti](http://bootswatch.com/yeti/) theme from http://bootswatch.com/
|
2014-04-12 16:04:17 -04:00
|
|
|
|
|
|
|
|
Common things that should be added in the near future *(pull requests are welcome!)*:
|
|
|
|
|
|
|
|
|
|
- Disqus integration
|
|
|
|
|
- More content types to demonstrate different layout methods
|
|
|
|
|
- About Me
|
|
|
|
|
- Contact
|
|
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
2014-09-02 15:05:20 -04:00
|
|
|
To get started, you should simply fork or clone this repository! That's definitely an important first step.
|
2014-04-12 16:04:17 -04:00
|
|
|
|
2014-09-27 03:35:42 -04:00
|
|
|
[Install Hugo](http://gohugo.io/overview/installing) in a way that best suits your environment and comfort level.
|
2014-04-12 16:04:17 -04:00
|
|
|
|
2014-09-02 15:05:20 -04:00
|
|
|
Edit `config.toml` and change the default properties to suit your own information. This is not required to run the
|
2014-04-12 16:04:17 -04:00
|
|
|
example, but this is the global configuration file and you're going to need to use it eventually. Start here!
|
|
|
|
|
|
2014-09-02 15:05:20 -04:00
|
|
|
In a command prompt or terminal, navigate to the path that contains your `config.toml` file and run `hugo`. That's it!
|
2014-04-12 16:04:17 -04:00
|
|
|
You should now have a `public` directory with a complete blog! Open `public/index.html` in your browser and bask.
|
|
|
|
|
|
2015-12-24 17:04:58 -05:00
|
|
|
If that wasn't amazing enough, from the same terminal, run `hugo server`. This will watch your directories for changes
|
2014-04-12 16:04:17 -04:00
|
|
|
and rebuild the site immediately, *and* it will make these changes available at http://localhost:1313/ so you can view
|
|
|
|
|
your finished site in your browser. Go on, try it. This is one of the best ways to preview your site while working on it.
|
|
|
|
|
|
2014-09-27 03:35:42 -04:00
|
|
|
To further learn Hugo and learn more, read through the Hugo [documentation](http://gohugo.io/overview/introduction)
|
2014-09-02 15:05:20 -04:00
|
|
|
or browse around the files in this repository. Have fun!
|
