Permalink
Browse files

πŸ˜‰ This is where it all begins...

  • Loading branch information...
nurlansu committed Oct 22, 2016
0 parents commit 58757f1f262c139529646285d0fc00eeec8b4bce
@@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2016 Nurlan Su
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
128 README.md
@@ -0,0 +1,128 @@
![Sustain - Logo][logo]
Table of Contents
-----------------
- [Installation](#installation)
- [Quick start](#quick-start)
- [Features](#features)
- [Syntax highlighting](#syntax-highlighting)
- [Disqus](#disqus)
- [Google Analytics](#google-analytics)
- [About](#about)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
********************
![Sustain Screen][screenshot]
********************
<p align="center"><b><a href="https://demo.sumaxi.me/themes/hugo-sustain/">Sustain Live Demo</a></b></p>
Installation
------------
#### With `git`
From the root of your Hugo site, clone the theme into `themes/hugo-sustain` by running :
```
git clone https://github.com/sumaxime/hugo-sustain.git themes/hugo-sustain
```
#### Manual
1. [Download][zip-archive] zip archive.
2. Unarchive it.
3. Move `hugo-sustain` folder in `themes` folder of your blog
For more information read the official [setup guide][hugo-guide] of Hugo.
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.
```
exampleSite
β”œβ”€β”€ config.toml
β”œβ”€β”€ content
β”‚Β Β  β”œβ”€β”€ projects
β”‚Β Β  β”‚Β Β  └── index.md
β”‚Β Β  └── blog
β”‚Β Β  β”œβ”€β”€ creating-a-new-theme.md
β”‚Β Β  β”œβ”€β”€ go-is-for-lovers.md
β”‚Β Β  β”œβ”€β”€ hugo-is-for-lovers.md
β”‚Β Β  └── migrate-from-jekyll.md
└── static
```
Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
Hugo includes a development server, so you can view your changes as you go -
very handy. Spin it up with the following command:
``` sh
hugo serve
```
Now you can go to [localhost:1313][local] and the Sustain
theme should be visible.
Features
--------
### Syntax highlighting
Use `highlight = true` in the front matter to include [`highlight.js`][highlight-js] javascript and css files.
### Disqus
To use this feature, uncomment and fill out the `disqusShortname` parameter in config.toml`.
### Google Analytics
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
-----
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
------------
Pull requests, bug fixes, and new features are welcome!
1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -a -m 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request on GitHub
Changelog
---------
> Version 1.0
- Initial release
License
-------
This theme is released under the [MIT license](LICENSE.md).
[logo]: https://i1.sumaxi.me/i/sustain.png
[screenshot]: https://i1.sumaxi.me/i/sustain-screen.png
[bootstrap]: https://getbootstrap.com/
[hugo]: https://gohugo.io/
[gh-pages]: https://pages.github.com/
[zip-archive]: https://github.com/sumaxime/hugo-sustain/archive/master.zip
[hugo-guide]: https://gohugo.io/overview/installing/
[local]: http://localhost:1313/
[highlight-js]: https://highlightjs.org/
[g-analytics]: https://www.google.com/analytics/
[sustain-jekyll]: https://github.com/biomadeira/sustain/
[sustain-author]: https://github.com/biomadeira/
@@ -0,0 +1,6 @@
+++
title = ""
description = ""
tags = []
categories = []
+++
@@ -0,0 +1,44 @@
baseurl = "https://example.com/"
languageCode = "en-US"
title = "Chris Turner"
# Enable comments by entering your Disqus shortname
disqusShortname = ""
# Enable Google Analytics by entering your tracking code
googleAnalytics = ""
theme = "hugo-sustain"
[permalinks]
post = "/:year/:month/:day/:slug"
[params]
avatar = "profile.png"
author = "Chris Turner"
description = "Describe your website"
# Custom assets can be linked with their paths relative to static/
custom_css = []
custom_js = []
[social]
Github = "username"
Email = "email@example.com"
Twitter = "username"
LinkedIn = "username"
Stackoverflow = "username"
## Main Menu
[[menu.main]]
name = "blog"
weight = 100
identifier = "blog"
url = "/blog/"
[[menu.main]]
name = "projects"
identifier = "projects"
weight = 200
url = "/projects/"
[[menu.main]]
name = "resume"
identifier = "resume"
weight = 300
url = "/resume/"
Oops, something went wrong.

0 comments on commit 58757f1

Please sign in to comment.