neil/hugo-sustain
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed some stuff in README.md

Browse Source
This commit is contained in:
Nurlan Su 2016-12-31 23:56:18 +01:00
parent 1d57db1d22
commit b0534fd85d
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,7 +1,6 @@
![Sustain - Logo][logo] ![Sustain - Logo][logo]
Table of Contents ## Table of Contents
-----------------
- [Installation](#installation) - [Installation](#installation)
- [Quick start](#quick-start) - [Quick start](#quick-start)
@ -22,8 +21,7 @@ Table of Contents
<p align="center"><b><a href="https://demo.sumaxi.me/themes/hugo-sustain/">Sustain Live Demo</a></b></p> <p align="center"><b><a href="https://demo.sumaxi.me/themes/hugo-sustain/">Sustain Live Demo</a></b></p>
Installation ## Installation
------------
#### With `git` #### With `git`
@ -40,8 +38,7 @@ git clone https://github.com/sumaxime/hugo-sustain.git themes/hugo-sustain
For more information read the official [setup guide][hugo-guide] of Hugo. For more information read the official [setup guide][hugo-guide] of Hugo.
Quick start ## Quick start
-----------
After installation, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation. After installation, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.
@ -71,8 +68,7 @@ hugo serve
Now you can go to [localhost:1313][local] and the Sustain Now you can go to [localhost:1313][local] and the Sustain
theme should be visible. theme should be visible.
Features ## Features
--------
### Syntax highlighting ### Syntax highlighting
@ -86,13 +82,11 @@ To use this feature, uncomment and fill out the `disqusShortname` parameter in c
To add Google Analytics, simply sign up to [Google Analytics][g-analytics] to obtain your Google Tracking ID, and add this tracking ID to the `googleAnalytics` parameter in `config.toml`. To add Google Analytics, simply sign up to [Google Analytics][g-analytics] to obtain your Google Tracking ID, and add this tracking ID to the `googleAnalytics` parameter in `config.toml`.
About ## About
-----
This is a port of the Jekyll theme [Sustain][sustain-jekyll] by [Fábio Madeira][sustain-author]. It supports most of the features of the original theme. This is a port of the Jekyll theme [Sustain][sustain-jekyll] by [Fábio Madeira][sustain-author]. It supports most of the features of the original theme.
Contributing ## Contributing
------------
Pull requests, bug fixes, and new features are welcome! Pull requests, bug fixes, and new features are welcome!
@ -102,17 +96,20 @@ Pull requests, bug fixes, and new features are welcome!
4. Push to the branch (`git push origin my-new-feature`) 4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request on GitHub 5. Create new Pull Request on GitHub
Changelog ## Changelog
---------
> Version 1.0 > Version 1.0
- Initial release - Initial release
License ## License
-------
<p align="center">
<a href="./LICENSE.md"><img src="https://i1.sumaxi.me/i/logo.svg" width="100%" height="128"></a>
<a href="./LICENSE.md"><strong>MIT</strong></a>
</p>
This theme is released under the [MIT license](LICENSE.md).
[logo]: https://i1.sumaxi.me/i/sustain.png [logo]: https://i1.sumaxi.me/i/sustain.png
[screenshot]: https://i1.sumaxi.me/i/sustain-screen.png [screenshot]: https://i1.sumaxi.me/i/sustain-screen.png