Skip to content

Commit 3c82d68

Browse files
author
Thierry Chappuis
committed
Updated the README.md file
1 parent 8054e81 commit 3c82d68

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
11
# PythonClassmates: Opinions d'étudiants en programmation python
22

33
Ce blog propose d'offrir une plateforme de publication collaborative maintenue par les étudiants et mentors du *discord* des étudiants ***DA Python*** et ***Data Scientists*** d'*Openclassrooms*. L'objectif de ce dernier est de fournir des news, des didacticiels, des critiques de livres, des astuces en relation avec le langage de programmation python.
4+
5+
## Contribuer
6+
7+
Pour contribuer à ce blog, il n'y a besoin d'aucun outils particuler. Il suffit de rédiger un article en commençant par créer un fichier .rst ou .md dans content/articles.
8+
9+
Pour un article au format ReStructuredText, l'en-tête du fichier .rst doit suivre le format suivant:
10+
```
11+
Le titre de mon article
12+
#######################
13+
14+
:date: 2018-07-14 14:00
15+
:modified: 2019-01-08 08:00
16+
:category: Articles
17+
:tags: tag1, tag2
18+
:lug: le-titre-de-mon-article-sous-forme-de-slug
19+
:author: Jean Dupont
20+
:summary: Version courte de l'article
21+
```
22+
23+
Pour un article au format Markdown, l'en-tête du fichier .md doit suivre le format suivant:
24+
```
25+
Title: Le titre de mon article
26+
Date: 2018-07-14 14:00
27+
Modified: 2019-01-08 08:00
28+
Category: Articles
29+
Tags: tag1, tag2
30+
Slug: le-titre-de-mon-article-sous-forme-de-slug
31+
Author: Jean Dupont
32+
```
33+
34+
## Outils pour visualiser son article
35+
36+
Pour pouvoir visualiser son article, les dépendances à installer sont:
37+
38+
- Python 3.6+
39+
- `$ pip3 install pipenv` ou `$ pip install pipenv` (sous windows)
40+
- `$ pipenv install`
41+
42+
Pour générer le html statique à partir de l'article en ReStructuredText ou en Markdown:
43+
44+
- `$ pipenv run invoke build`
45+
46+
Pour visualiser son article sur [http://localhost:8000](http://localhost:8000):
47+
48+
- `$ pipenv run invoke runserver` (Vous pouvez arrêter le server en appuyant sur CTRL+C ou Cmd+C selon l'OS)

0 commit comments

Comments
 (0)