github.com/shohhei1126/hugo@v0.42.2-0.20180623210752-3d5928889ad7/examples/blog/README.md (about)

     1  Hugo Example Blog
     2  =================
     3  
     4  This repository provides a fully-working example of a [Hugo](https://github.com/gohugoio/hugo)-powered blog. Many
     5  Hugo-specific features are used as a way to see them in action, and hopefully ease the learning curve for creating your
     6  very own site with Hugo.
     7  
     8  Features
     9  --------
    10  
    11  - Recent Posts at main index
    12  - Indexes for `tags` and `categories`
    13  - Post information block, with links for all `tags` and `categories` post belongs to
    14  - [Bootstrap 3](http://getbootstrap.com/) ready
    15    - Currently using the [Yeti](http://bootswatch.com/yeti/) theme from http://bootswatch.com/
    16  
    17  Common things that should be added in the near future *(pull requests are welcome!)*:
    18  
    19  - Disqus integration
    20  - More content types to demonstrate different layout methods
    21    - About Me
    22    - Contact
    23  
    24  Getting Started
    25  ---------------
    26  
    27  To get started, you should simply fork or clone this repository! That's definitely an important first step.
    28  
    29  [Install Hugo](http://gohugo.io/overview/installing) in a way that best suits your environment and comfort level.
    30  
    31  Edit `config.toml` and change the default properties to suit your own information. This is not required to run the
    32  example, but this is the global configuration file and you're going to need to use it eventually. Start here!
    33  
    34  In a command prompt or terminal, navigate to the path that contains your `config.toml` file and run `hugo`. That's it!
    35  You should now have a `public` directory with a complete blog! Open `public/index.html` in your browser and bask.
    36  
    37  If that wasn't amazing enough, from the same terminal, run `hugo server`. This will watch your directories for changes
    38  and rebuild the site immediately, *and* it will make these changes available at http://localhost:1313/ so you can view
    39  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.
    40  
    41  To further learn Hugo and learn more, read through the Hugo [documentation](http://gohugo.io/overview/introduction)
    42  or browse around the files in this repository. Have fun!