<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Pelican for YunoHost

[![Integration level](https://dash.yunohost.org/integration/pelican.svg)](https://dash.yunohost.org/appci/app/pelican) ![Working status](https://ci-apps.yunohost.org/ci/badges/pelican.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pelican.maintain.svg)

[![Install Pelican with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pelican)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Pelican quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Pelican is a static site generator, written in Python.

* Compose content in Markdown_ or reStructuredText_ using your editor of choice
* Simple command-line tool (re)generates HTML, CSS, and JS from your source content
* Easy to interface with version control systems and web hooks
* Completely static output is simple to host anywhere


**Shipped version:** 4.8.0~ynh1
## Documentation and resources

* Official app website: <https://blog.getpelican.com>
* Official admin documentation: <https://docs.getpelican.com/en/latest/index.html>
* Upstream app code repository: <https://github.com/getpelican/pelican>
* YunoHost documentation for this app: <https://yunohost.org/app_pelican>
* Report a bug: <https://github.com/YunoHost-Apps/pelican_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pelican_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug
or
sudo yunohost app upgrade pelican -u https://github.com/YunoHost-Apps/pelican_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>