flex/README.md

105 lines
3.9 KiB
Markdown
Raw Normal View History

2023-03-31 23:51:41 +02:00
# Flex
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
2023-03-31 23:51:41 +02:00
## Flex 3.0 and upcoming breaking changes
2017-02-20 20:01:05 +01:00
2023-03-31 23:51:41 +02:00
Flex 2.6 will be the last release without breaking changes.
Flex 3.0 is under development and will introduce breaking changes.
The breaking changes will include:
* Removal of deprecated plugins and integrations
* Removal and renaming of configuration variables
* Removal of Less.js and Gulp.js
* Refactoring of multiple templates
Flex has grown beyond expectation over the last few years and is hard to maintain and accept new features.
You can check the current progress in the `v3` branch.
New features won't be accepted unless submited to `v3` branch, bug fixes will still be accepted in the `master` branch.
Once 2.6 is out, the `v3` branch will be merged into `master`.
2017-02-20 20:01:05 +01:00
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)
2017-03-14 05:17:17 +01:00
- Related Posts (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts) or AddThis)
- Series (via [plugin](https://github.com/pelican-plugins/series))
2021-02-04 22:43:39 +01:00
- Minute read (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/post_stats))
2017-03-14 04:47:35 +01:00
- [Multiple Code Highlight Styles](https://github.com/alexandrevicenzi/Flex/wiki/Code-Highlight)
2021-02-04 22:43:39 +01:00
- [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations)
- [Dark Mode](https://github.com/alexandrevicenzi/Flex/wiki/Dark-Mode)
2015-07-19 02:04:01 +02:00
## Integrations
2020-09-19 21:57:42 +02:00
- [AddThis](http://www.addthis.com/)
2015-11-25 02:54:18 +01:00
- [Disqus](https://disqus.com/)
2017-04-22 08:41:39 +02:00
- [Gauges Analytics](http://get.gaug.es/)
2021-02-04 22:43:39 +01:00
- [Google AdSense](https://www.google.com.br/adsense/start/)
2015-11-25 02:54:18 +01:00
- [Google Analytics](https://www.google.com/analytics/web/)
- [Google Tag Manager](https://www.google.com/tagmanager/)
- [Matomo Analytics (formerly Piwik)](https://matomo.org/)
- [Cloudflare Web Analytics](https://www.cloudflare.com/web-analytics/)
- [Plausible](https://plausible.io/)
2015-11-25 02:54:18 +01:00
- [StatusCake](https://www.statuscake.com/)
2021-02-04 22:43:39 +01:00
- [Isso](https://posativ.org/isso/)
- [Microsoft Clarity](https://clarity.microsoft.com)
2017-03-14 05:17:17 +01:00
## Plugins Support
2021-02-04 22:43:39 +01:00
- [Github Corners](https://github.com/tholman/github-corners)
- [I18N Sub-sites](https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites)
- [Minute read](https://github.com/getpelican/pelican-plugins/tree/master/post_stats)
2017-03-14 05:17:17 +01:00
- [Related Posts](https://github.com/getpelican/pelican-plugins/tree/master/related_posts)
- [Series](https://github.com/pelican-plugins/series)
2021-02-04 22:43:39 +01:00
- [Representative image](https://github.com/getpelican/pelican-plugins/tree/master/representative_image)
- [Neighbors](https://github.com/getpelican/pelican-plugins/tree/master/neighbors)
- [Pelican Search](https://github.com/pelican-plugins/search)
2022-03-10 10:40:22 +01:00
- [Tipue Search](https://github.com/getpelican/pelican-plugins/blob/master/tipue_search/) (deprecated)
2021-04-21 22:51:01 +02:00
- [SEO](https://github.com/pelican-plugins/seo)
2015-07-19 02:04:01 +02:00
2016-04-24 00:44:16 +02:00
## Install
2018-06-24 06:55:49 +02:00
The best way to install is over [pelican-themes](https://github.com/getpelican/pelican-themes).
2016-04-24 00:44:16 +02:00
2023-03-31 23:51:41 +02:00
The alternative way is to clone this repository and checkout a tag branch.
2016-04-24 00:44:16 +02:00
2018-06-24 06:55:49 +02:00
## 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)
2017-07-13 04:22:43 +02:00
## Live example
2020-09-19 21:57:42 +02:00
You can see how this theme looks like at [http://flex.alxd.me/](http://flex.alxd.me/).
2017-07-13 04:22:43 +02:00
2018-06-24 06:55:49 +02:00
The code is available in this project under `docs` folder.
## Contributing
**ALWAYS** open an issue before sending a PR.
2023-03-31 23:51:41 +02:00
Discuss the problem/feature that you want to solve.
If things make sense, send a PR with your changes.
2018-06-24 06:55:49 +02:00
As always, if you want something that only makes sense to you, fork Flex and create a new theme.
2017-03-14 04:23:49 +01:00
2018-06-24 06:55:49 +02:00
## Translations
2016-08-25 04:39:12 +02:00
Translate this theme to new languages at [Transifex](https://www.transifex.com/alexandrevicenzi/flex-pelican/).
2018-06-24 06:55:49 +02:00
Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations) in the Wiki.
2016-08-25 04:39:12 +02:00
2015-07-19 02:04:01 +02:00
## License
MIT