parent
78383734c1
commit
3dbd814502
|
@ -0,0 +1,74 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team. All complaints will be reviewed and
|
||||
investigated and will result in a response that is deemed necessary and
|
||||
appropriate to the circumstances. The project team is obligated to maintain
|
||||
confidentiality with regard to the reporter of an incident. Further details of
|
||||
specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
42
README.md
42
README.md
|
@ -1,14 +1,10 @@
|
|||
# pelican-alchemy
|
||||
|
||||
Alchemy ✨ is a functional, clean, responsive theme for the [Pelican](http://getpelican.com) static site generator. Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog).
|
||||
**Alchemy** ✨ is a functional, clean, responsive theme for the [Pelican](http://getpelican.com) static site generator.
|
||||
|
||||
## Screenshot
|
||||
Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog), it features:
|
||||
|
||||
![Screenshot](screenshot.jpg "Screenshot")
|
||||
|
||||
## Features
|
||||
|
||||
- Powered by [Bootstap 4](http://v4-alpha.getbootstrap.com/)
|
||||
- Built with [Bootstap 4](http://v4-alpha.getbootstrap.com/) (v4-alpha)
|
||||
- [Favicon Generator](http://realfavicongenerator.net/) support
|
||||
- [Font Awesome](http://fontawesome.io/) icons
|
||||
- [Pygments](http://pygments.org/) syntax highlighting styles
|
||||
|
@ -16,28 +12,38 @@ Alchemy ✨ is a functional, clean, responsive theme for the [Pelican](http://ge
|
|||
- External analytics (Google Analytics, Gauges, Piwik)
|
||||
- External comments (Disqus)
|
||||
|
||||
![Screenshot](screenshot.jpg "Screenshot")
|
||||
|
||||
## Installation
|
||||
|
||||
Clone the repo:
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/nairobilug/pelican-alchemy
|
||||
```
|
||||
|
||||
Set the `THEME` variable in your Pelican config:
|
||||
|
||||
```python
|
||||
THEME = '/PATH_TO_REPO/alchemy'
|
||||
```
|
||||
|
||||
### As a submodule
|
||||
### As a Submodule
|
||||
|
||||
In your Pelican site:
|
||||
|
||||
```shell
|
||||
$ mkdir themes
|
||||
$ git submodule add https://github.com/nairobilug/pelican-alchemy themes/pelican-alchemy
|
||||
```
|
||||
|
||||
And Pelican config:
|
||||
And in Pelican config:
|
||||
|
||||
```python
|
||||
THEME = 'themes/pelican-alchemy/alchemy'
|
||||
```
|
||||
|
||||
## Settings
|
||||
## Usage
|
||||
|
||||
Visit the [Settings wiki](https://github.com/nairobilug/pelican-alchemy/wiki/Settings) for examples:
|
||||
|
||||
|
@ -60,6 +66,20 @@ Misc settings:
|
|||
|
||||
Example [pelicanconf.py](https://github.com/nairobilug/pelican-alchemy/blob/demo/pelicanconf.py) (demo website).
|
||||
|
||||
## Tips & Tricks
|
||||
### Tips & Tricks
|
||||
|
||||
[https://github.com/nairobilug/pelican-alchemy/wiki/Tips](https://github.com/nairobilug/pelican-alchemy/wiki/Tips)
|
||||
|
||||
## Maintainers
|
||||
|
||||
- [@nairobilug](https://github.com/nairobilug)
|
||||
|
||||
## Contribute
|
||||
|
||||
Feel free to dive in. [Open an issue](https://github.com/nairobilug/pelican-alchemy/issues/new) or submit a PR.
|
||||
|
||||
**Alchemy** follows the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE) © Nairobi GNU/Linux Users Group
|
||||
|
|
Loading…
Reference in New Issue