Update README file
This commit is contained in:
parent
52f54ffcce
commit
e61f7db9a2
1 changed files with 1 additions and 52 deletions
53
README.md
53
README.md
|
@ -1,53 +1,2 @@
|
||||||
# Cactus Theme for Jekyll
|
bundle exec jekyll serve
|
||||||
|
|
||||||
This is a port of [Cactus](https://github.com/koenbok/Cactus)'s default theme for Jekyll.
|
|
||||||
Feel free to fork, change, modify and re-use it.
|
|
||||||
|
|
||||||
## How to use it
|
|
||||||
|
|
||||||
Simply clone this repository, and then run `jekyll serve` inside the directory.
|
|
||||||
This theme is fully compliant with GH Pages and their dependencies.
|
|
||||||
For extra info: [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/#keeping-jekyll-up-to-date).
|
|
||||||
|
|
||||||
Cactus theme includes:
|
|
||||||
|
|
||||||
* Pagination
|
|
||||||
* Rss feed
|
|
||||||
* Google Analytics Tracking code
|
|
||||||
* Code Syntax Highlight
|
|
||||||
* Author's profile with picture header
|
|
||||||
* Twitter/Facebook share buttons
|
|
||||||
* Archive posts list under each post
|
|
||||||
* Disqus comments
|
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||
![index page](https://raw.githubusercontent.com/nickbalestra/kactus/master/assets/images/Kactus-theme-index.png)
|
|
||||||
![post page](https://raw.githubusercontent.com/nickbalestra/kactus/master/assets/images/Kactus-theme-post.png)
|
|
||||||
|
|
||||||
|
|
||||||
## Thanks
|
|
||||||
Most of the work has been already done by the [Cactus for mac authors](https://github.com/koenbok/Cactus/blob/master/AUTHORS), I've just ported their default theme to Jekyll.
|
|
||||||
I've also added few things specific to Jekyll and some minor style changes.
|
|
||||||
|
|
||||||
## Copyright & License
|
|
||||||
|
|
||||||
Copyright (c) 2015 [Cactus Authors](https://github.com/koenbok/Cactus/blob/master/AUTHORS) - Released under the MIT License.
|
|
||||||
|
|
||||||
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.
|
|
Loading…
Reference in a new issue