71 lines
3.2 KiB
Markdown
71 lines
3.2 KiB
Markdown
# 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)
|
|
|
|
The minimalist [Pelican](http://blog.getpelican.com/) theme.
|
|
|
|
## Features
|
|
|
|
- Mobile First
|
|
- Responsive
|
|
- Semantic
|
|
- SEO Best Practices
|
|
- Open Graph
|
|
- Rich Snippets (JSON-LD)
|
|
- Related Posts (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts))
|
|
- Minute read like [Medium](https://medium.com/) (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/post_stats)) (new in 2.0)
|
|
- [Multiple Code Highlight Styles](https://github.com/alexandrevicenzi/Flex/wiki/Code-highlight-support)
|
|
- [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translation-support) (new in 2.0)
|
|
|
|
## Integrations
|
|
|
|
- [AddThis](http://www.addthis.com/)
|
|
- [Disqus](https://disqus.com/)
|
|
- [Gauges](http://get.gaug.es/)
|
|
- [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/)
|
|
|
|
## 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.
|
|
|
|
## Docs
|
|
|
|
[Go to Wiki](https://github.com/alexandrevicenzi/Flex/wiki)
|
|
|
|
## 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.
|
|
|
|
## Translate
|
|
|
|
Translate this theme to new languages at [Transifex](https://www.transifex.com/alexandrevicenzi/flex-pelican/).
|
|
|
|
![Translations](https://github.com/alexandrevicenzi/Flex/blob/master/translation_chart.png)
|
|
|
|
Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translation-support).
|
|
|
|
## Live example
|
|
|
|
You can see how things looks like [here](https://blog.alexandrevicenzi.com/flex-pelican-theme.html).
|
|
Or you can take a look at [Flex users](https://github.com/alexandrevicenzi/Flex/wiki/Flex-users).
|
|
|
|
I'm using Flex in my [personal blog](http://blog.alexandrevicenzi.com/).
|
|
|
|
![Screenshot](https://github.com/alexandrevicenzi/Flex/blob/master/screenshot.png)
|
|
|
|
## Donate
|
|
|
|
Did you liked this theme? Buy me a beer and support new features.
|
|
|
|
[![Gratipay](https://img.shields.io/gratipay/user/alexandrevicenzi.svg?maxAge=2592000)](https://gratipay.com/~alexandrevicenzi/)
|
|
|
|
[![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¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
|
|
|
|
## License
|
|
|
|
MIT
|