flex/README.md

89 lines
3.8 KiB
Markdown
Raw Normal View History

2016-08-11 22:07:48 +02:00
# Flex [![Build Status](https://travis-ci.org/alexandrevicenzi/Flex.svg?branch=master)](https://travis-ci.org/alexandrevicenzi/Flex) [![Dependency Status](https://david-dm.org/alexandrevicenzi/Flex.svg)](https://david-dm.org/alexandrevicenzi/Flex) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alexandre-vicenzi/flex?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2015-07-19 02:04:01 +02:00
2016-08-25 04:39:12 +02:00
The minimalist [Pelican](http://blog.getpelican.com/) theme.
2015-07-19 02:04:01 +02:00
2017-02-20 20:01:05 +01:00
## Note
DON'T send any questions, issues or anything related to Flex to my personal email. They will be IGNORED by now. Your question is someone else question. They SHOULD be public, so others can know how to fix configuration problems.
2015-07-19 02:04:01 +02:00
## Features
- Mobile First
- Responsive
- Semantic
2015-07-19 02:22:29 +02:00
- SEO Best Practices
2015-07-20 04:34:54 +02:00
- Open Graph
- Rich Snippets (JSON-LD)
2016-08-12 02:05:34 +02:00
- Related Posts (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts))
2016-08-25 02:56:38 +02:00
- Minute read like [Medium](https://medium.com/) (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/post_stats)) (new in 2.0)
2016-08-19 18:23:33 +02:00
- [Multiple Code Highlight Styles](https://github.com/alexandrevicenzi/Flex/wiki/Code-highlight-support)
2016-08-25 02:56:38 +02:00
- [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translation-support) (new in 2.0)
2015-07-19 02:04:01 +02:00
## Integrations
2015-11-25 02:54:18 +01:00
- [AddThis](http://www.addthis.com/)
- [Disqus](https://disqus.com/)
- [Gauges](http://get.gaug.es/)
2016-11-08 01:13:43 +01:00
- [Google AdSense](https://www.google.com.br/adsense/start/) (new in 2.1)
2015-11-25 02:54:18 +01:00
- [Google Analytics](https://www.google.com/analytics/web/)
- [Google Tag Manager](https://www.google.com/tagmanager/)
- [Piwik](http://piwik.org/)
- [StatusCake](https://www.statuscake.com/)
2017-03-14 04:23:49 +01:00
- [Github Corners](https://github.com/tholman/github-corners) (new in 2.2)
- [Representative image](https://github.com/getpelican/pelican-plugins/tree/master/representative_image) (new in 2.2)
2015-07-19 02:04:01 +02:00
2016-04-24 00:44:16 +02:00
## Install
The recommend way to install is over [pelican-themes](https://github.com/getpelican/pelican-themes).
The `master` branch is the development branch. If you're happy with fresh new things and maybe sometimes (~most of time~) broken things you can clone the `master`, but I would recommend to you to clone a tag branch.
2016-02-03 16:32:25 +01:00
## Docs
2015-07-19 02:04:01 +02:00
2015-10-07 00:14:44 +02:00
[Go to Wiki](https://github.com/alexandrevicenzi/Flex/wiki)
2015-07-21 05:49:51 +02:00
2016-04-24 00:44:16 +02:00
## Contributing
Always open an issue before sending a PR. Talk about the problem/feature that you want to fix. If it's really a good thing you can submit your PR. If you send an PR without talking about before what it is, you may work for nothing.
As always, if you want something that only make sense to you, just fork Flex and start a new theme.
2017-03-14 04:23:49 +01:00
## Donate
Did you liked this theme? Buy me a beer and support new features.
### PayPal
[![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg?maxAge=2592000)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=KZCMH3N74KKFN&lc=BR&item_name=Alexandre%20Vicenzi&item_number=flex&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
### Bitcoin
![Screenshot](https://github.com/alexandrevicenzi/Flex/blob/master/btc.png)
`1Heza38sS36iTtaFpWB5wziuiK9WChmwss`
2016-08-25 04:39:12 +02:00
## Translate
Translate this theme to new languages at [Transifex](https://www.transifex.com/alexandrevicenzi/flex-pelican/).
2016-08-25 04:41:39 +02:00
![Translations](https://github.com/alexandrevicenzi/Flex/blob/master/translation_chart.png)
2016-08-25 04:39:12 +02:00
2017-03-14 04:25:47 +01:00
Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations).
2016-08-25 04:39:12 +02:00
2015-07-19 02:04:01 +02:00
## Live example
2015-07-24 01:43:01 +02:00
You can see how things looks like [here](https://blog.alexandrevicenzi.com/flex-pelican-theme.html).
2015-11-25 03:09:43 +01:00
Or you can take a look at [Flex users](https://github.com/alexandrevicenzi/Flex/wiki/Flex-users).
2015-07-24 01:43:01 +02:00
I'm using Flex in my [personal blog](http://blog.alexandrevicenzi.com/).
2015-07-19 02:04:01 +02:00
2015-07-19 02:28:34 +02:00
![Screenshot](https://github.com/alexandrevicenzi/Flex/blob/master/screenshot.png)
2015-07-19 02:04:01 +02:00
## License
MIT
2017-03-14 04:23:49 +01:00
## Contributors
[Contributors list](https://github.com/alexandrevicenzi/Flex/graphs/contributors)