schtobia/flex
1
0
Fork 0
Code Issues Pull requests Activity

Update readme.

Browse source
This commit is contained in:
Alexandre Vicenzi 2018-06-24 01:55:49 -03:00
parent b3bd59002a
commit 5a41ce0093
1 changed files with 28 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -2,9 +2,11 @@
The minimalist [Pelican](http://blog.getpelican.com/) theme. The minimalist [Pelican](http://blog.getpelican.com/) theme.
## Note ## Notes
DON'T send any questions, issues or anything related to Flex to my personal email. They will be IGNORED by now. Your question maybe also is someone else's question. They SHOULD be public, so others can know how to fix configuration problems. - **DO NOT** send any questions to my personal email, they are **IGNORED**. If you have questions open an issue.
- This theme is not under development anymore, it's stable and has a lot of features. This means that new requests (not bug fixes) will be discussed and have lower priorities.
- If you want a version of this theme to Jekyll or Hugo open an issue and let's discuss it.
## Features ## Features
@ -24,7 +26,7 @@ DON'T send any questions, issues or anything related to Flex to my personal emai
- [AddThis](http://www.addthis.com/) Share Buttons and Related Posts - [AddThis](http://www.addthis.com/) Share Buttons and Related Posts
- [Disqus](https://disqus.com/) - [Disqus](https://disqus.com/)
- [Gauges Analytics](http://get.gaug.es/) - [Gauges Analytics](http://get.gaug.es/)
- [Google AdSense](https://www.google.com.br/adsense/start/) (new in 2.1) - [Google AdSense](https://www.google.com.br/adsense/start/) (new in 2.1.0)
- [Google Analytics](https://www.google.com/analytics/web/) - [Google Analytics](https://www.google.com/analytics/web/)
- [Google Tag Manager](https://www.google.com/tagmanager/) - [Google Tag Manager](https://www.google.com/tagmanager/)
- [Piwik Analytics](http://piwik.org/) - [Piwik Analytics](http://piwik.org/)
@ -32,28 +34,18 @@ DON'T send any questions, issues or anything related to Flex to my personal emai
## Plugins Support ## Plugins Support
- [Github Corners](https://github.com/tholman/github-corners) (new in 2.2) - [Github Corners](https://github.com/tholman/github-corners) (new in 2.2.0)
- [I18N Sub-sites](https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites) (new in 2.0) - [I18N Sub-sites](https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites) (new in 2.0)
- [Minute read](https://github.com/getpelican/pelican-plugins/tree/master/post_stats) (new in 2.0) - [Minute read](https://github.com/getpelican/pelican-plugins/tree/master/post_stats) (new in 2.0)
- [Related Posts](https://github.com/getpelican/pelican-plugins/tree/master/related_posts) - [Related Posts](https://github.com/getpelican/pelican-plugins/tree/master/related_posts)
- [Representative image](https://github.com/getpelican/pelican-plugins/tree/master/representative_image) (new in 2.2) - [Representative image](https://github.com/getpelican/pelican-plugins/tree/master/representative_image) (new in 2.2.0)
- [Neighbors](https://github.com/getpelican/pelican-plugins/tree/master/neighbors) (new in 2.2) - [Neighbors](https://github.com/getpelican/pelican-plugins/tree/master/neighbors) (new in 2.2.0)
## Install ## Install
The recommend way to install is over [pelican-themes](https://github.com/getpelican/pelican-themes). The best 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 broken things you can clone the `master`, but I would recommend to you to clone a tag branch. The alternative way is to clone this repository. The `master` branch is stable and is safe to checkout, but I would recommend you to checkout a tag branch.
## Documentation
[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.
## Donate ## Donate
@ -61,19 +53,34 @@ Are you using this theme? Support bug fixes and new features.
[Click here](https://www.alexandrevicenzi.com/donate) to donate. [Click here](https://www.alexandrevicenzi.com/donate) to donate.
## Documentation
The documentation covers most of the settings available and how to use this theme.
If something is missing or broken you can open a PR or fix the documentation by yourself.
[Flex Wiki](https://github.com/alexandrevicenzi/Flex/wiki)
## Live example ## Live example
You can see how this theme looks like at [http://flex.alxd.me/blog/](http://flex.alxd.me/blog/). You can see how this theme looks like at [http://flex.alxd.me/blog/](http://flex.alxd.me/blog/).
The code is available in this project inside `docs` folder. The code is available in this project under `docs` folder.
## Translate ## Contributing
**ALWAYS** open an issue before sending a PR.
Discuss the problem/feature that you want to code.
After discussing, send a PR with your changes.
As always, if you want something that only makes sense to you, fork Flex and create a new theme.
## Translations
Translate this theme to new languages at [Transifex](https://www.transifex.com/alexandrevicenzi/flex-pelican/). Translate this theme to new languages at [Transifex](https://www.transifex.com/alexandrevicenzi/flex-pelican/).
![Translations](https://github.com/alexandrevicenzi/Flex/blob/master/translations/translation_chart.png) ![Translations](https://github.com/alexandrevicenzi/Flex/blob/master/translations/translation_chart.png)
Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations). Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations) in the Wiki.
## License ## License