Documentation

Mediashare ce repose sur l'outil PostIT développé en open-source. PostIT est un CMS libre de droit, basé sur l'usage de Markdown, Twig et de Symfony.

Installation

git clone https://github.com/Mediashare/PostIT && cd PostIT
composer install # Install dependencies
composer dump-env prod # Or dev
nano .env.local.php # Edit configuration file
bin/console doctrine:schema:update --force # Create database and tables

Usages

Tout d'abord, il vous faudra créer un compte vous permettant de vous connectez à la plateforme.

Une fois connecté, cliquer sur le bouton dans le menu à droite de votre page, vous devrez cliquer sur article ou un lien pour créer une publication.

Dans votre formulaire, vous pouvez écrire du Markdown et du Twig

Mardown

Markdown est un langage de balisage léger créé en 2004 par John Gruber avec l'aide d'Aaron Swartz. Il a été créé dans le but d'offrir une syntaxe facile à lire et à écrire. Un document balisé par Markdown peut être lu en l'état sans donner l’impression d'avoir été balisé ou formaté par des instructions particulières.

Titres

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3
#### Titre niveau 4
##### Titre niveau 5
###### Titre niveau 6
Titre alternative 1
=======
Titre alternative 2
-------

Décoration de texte

**Texte en gras**
*Texte en italique*

Citations

> La citation du jour

Listes

* Premier élément.
* Second élément.
    * Sous-élément.

Liens

[Texte du lien](url)
[Texte du lien 2](url "label de l'image")

Images

![Titre de l'image](/liens/vers/image.jpg)

Css

Vous pouvez modifier vos éléments markdown avec du css. Le site implémente le framework Bootstrap v4.5.1.

[Bouton](url){.btn .btn-success .p-1}
![Image centrée](url){.d-flex .mx-auto}

Les templates Twig

Rendez-vous sur la page de création de template. Renseigner un nom, qui vous permettra de l'identifier, puis vous pouvez commencer à écrire votre premier template. Pour moi ça ressemble à ça:

<div class="card rounded shadow-lg">
    <div class="card-body">
        Petit texte dans une card...
    </div>
</div>

Une fois enregistré, ce template peut être utiliser dans n'importe quelle article que vous publirez. Pour cela, il vous suffit simplement d'invoquer votre template via la fonction template de Twig.

{{ template('template_name') }} # Données brutes avec balise html
{{ template('template_name')|raw }} # Interprète le html

API

Une API est une interface permettant de communiquer avec une application. Dans notre cas, l'interface vous permettra de lires et d'écrires des articles sur la plateforme.

Liste

Récupérer la liste des publications en ligne.

curl https://mediashare.fr/api/posts

Lire

Récupérer une publication en ligne via son ID.

curl https://mediashare.fr/api/post/ID

Créer

Pour créer une publication vous aurez besoin de renseignez votre ApiKey dans les headers de la requête.

echo "# LoremIpsum is beautiful" > LoremIpsum.md
curl \
    -H "ApiKey: {YOUR_APIKEY}" \
    -F "title=Lorem Ipsum" \
    -F "content=@./LoremIpsum.md" \
    -F "online=true" \
    https://mediashare.fr/upload