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

Update README from Flex to Reflex

Browse source
This commit is contained in:
Fidel Ramos 2022-07-04 10:16:42 +02:00
parent af0cfa52e3
commit aaa6206ca5
No known key found for this signature in database
GPG key ID: 379F14BB02F9317F
1 changed files with 11 additions and 30 deletions

41
README.md
View file

@ -1,12 +1,6 @@
# Flex [![Build Status](https://travis-ci.org/alexandrevicenzi/Flex.svg?branch=master)](https://travis-ci.org/alexandrevicenzi/Flex)
# Reflex
The minimalist [Pelican](http://blog.getpelican.com/) theme.
## Notes
- If you have questions open an issue
- The theme is not under huge development anymore, it's stable and has a lot of features already
- If you want a [Hugo](https://gohugo.io/) theme check out [Soho](https://github.com/alexandrevicenzi/soho)
A minimalist [Pelican](http://blog.getpelican.com/) theme, forked from [Flex](https://github.com/alexandrevicenzi/Flex).
## Features
@ -48,37 +42,24 @@ The minimalist [Pelican](http://blog.getpelican.com/) theme.
## Install
The best way to install is over [pelican-themes](https://github.com/getpelican/pelican-themes).
If you want to try out multiple themes the best way is to use [pelican-themes](https://github.com/getpelican/pelican-themes).
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.
The alternative way is to clone this repository.
The `master` branch should be stable and safe to checkout.
Then point your `THEME` setting in the pelican project to the path of the theme.
## Documentation
## Sites using Reflex
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.
- [https://blog.fidelramos.net/](https://blog.fidelramos.net/) ([source code](https://github.com/haplo/blog.fidelramos.net))
[Flex Wiki](https://github.com/alexandrevicenzi/Flex/wiki)
## Live example
You can see how this theme looks like at [http://flex.alxd.me/](http://flex.alxd.me/).
The code is available in this project under `docs` folder.
If you have a site using Reflex feel free to open a PR to add it here.
## Contributing
**ALWAYS** open an issue before sending a PR.
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/).
Read more about [Translation Support](https://github.com/alexandrevicenzi/Flex/wiki/Translations) in the Wiki.
## License
MIT
MIT ([full license](LICENSE))