Commit 39e53379 authored by Hugo Trentesaux's avatar Hugo Trentesaux

nettoyage

parent a2ea78da
.idea/
__pycache__/*
__pycache__/
bin/
include/
lib/
......
Lisez-moi (s'il-vous-plaît)
===
## Markdown
### Retours à la ligne
Les retours à la ligne simples semblent ne pas provoquer de retour à la ligne lors conversion vers HTML (à confirmer).
### Listes à puce
Le nombre d'espaces à rajouter devant le caractère "\*" ou "-" pour faire une sous-liste est : 4.
## Notes de développement
* Vous pouvez définir COMPILE_LESS_INTO_CSS à False pour le développement. Notez cependant que les liens vers les ancres peuvent alors ne pas fonctionner.
## Ressources CSS utiles
* [Documentation de l'extension Markdown qui gère la génération de sommaires](https://python-markdown.github.io/extensions/toc/)
* [Flexbox : comprendre le dimensionnement des images](https://codepen.io/dudleystorey/pen/pejpYW)
# Duniter website
Public site available at https://duniter.org/fr
## Reproduce it locally
You may want to reproduce this website locally, for developement purposes for example. Here are the instructions.
Clone the sources
git clone https://github.com/duniter/website_fr.git
Install python stuff
cd website_fr
sudo apt install virtualenv
virtualenv .
source bin/activate
pip install pelican pelican-youtube markdown plantuml-markdown beautifulsoup4 cssmin webassets pelican-webassets
Install [LESS compiler](https://github.com/canaryhealth/lessc):
npm install less
export PATH="`pwd`/node_modules/.bin:$PATH"
pip install lessc
Install system dependencies for plantuml plugin (plantuml and GraphViz utilities):
```bash
apt install plantuml graphviz
```
Generate the site
pelican
Serve it
./develop_server.sh start 8556
The website should be available at : http://localhost:8556
## Manage the development server
Parameters available
* default port: 8556
* start <port_number>
* restart <port_number>
* stop
If you want to use an another port number :
1) Edit the ```SITEURL``` variable in ```pelicanconf.py``` file
2) ./develop_server.sh {start|restart} <port_number>
## Generate production site
To permit a nice-looking license inclusion in the wiki, we use a pre-run script that should be ran before creating the site with pelican:
You just need to give the production configuration file to Pelican:
pelican -s publishconf.py
You may want to change the production parameters, like the domain name: just edit `publishconf.py` and modify the `SITEURL` to whatever value you want.
For example if you want to host the site at `https://my.website.org`, set:
SITEURL = u'https://my.website.org'
## Plantuml plugin documentation
* Plantuml plugin documentation : https://github.com/Scheirle/pelican-plugins/tree/master/plantuml
* Plantuml documentation: http://plantuml.com
* Plantuml support DOT language of GraphViz: http://www.graphviz.org/Gallery.php
......@@ -25,4 +25,16 @@ pelican content
pelican --autoreload --listen
```
## :)
\ No newline at end of file
## Autre
### Plantuml plugin documentation
* Plantuml plugin documentation : https://github.com/Scheirle/pelican-plugins/tree/master/plantuml
* Plantuml documentation: http://plantuml.com
* Plantuml support DOT language of GraphViz: http://www.graphviz.org/Gallery.php
### Ressources CSS utiles
* [Documentation de l'extension Markdown qui gère la génération de sommaires](https://python-markdown.github.io/extensions/toc/)
* [Flexbox : comprendre le dimensionnement des images](https://codepen.io/dudleystorey/pen/pejpYW)
<section id="CTA-develloper" class="container{% if BOOTSTRAP_FLUID %}-fluid{% endif %}">
<div>
<h2>Vous êtes développeur ?</h2>
<p>
Vous avez des questions qui n'ont pas trouvé réponse sur ce site ?
</p>
<p>
Vous aimeriez savoir comment vous pouvez contribuer ?
</p>
<p>
<a href="https://forum.duniter.org/c/presentations" class="CTA">
Présentez-vous sur le forum
</a>
</p>
</div>
</section>
<!--
<section id="thx">
<div>
<h2><strong>Merci</strong> <span>à nos mécènes</span> <span>du mois dernier :</span></h2>
<iframe width="100%" class="autoHeight" src="https://growdfunding.borispaing.fr/iframe.php?target=1000&amp;title=les%20développeurs%20de%20Duniter&amp;theme=cloud&amp;unit=relative&amp;start_date=2020-01-01&amp;end_date=2020-01-31&amp;pubkey=78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8"></iframe>
</div>
</section>
<section class="support">
<div>
<h2>Financez les développeurs</h2>
<p>
Duniter est <a href="{{ SITEURL }}/{% print(PAGE_URL.replace('{slug}', 'financements')) %}">financé par ses utilisateurs</a>.
</p>
<p>
Les dons servent à indemniser le travail des différents contributeurs (développeurs, traducteurs, graphistes, etc.).
Nous sommes une vingtaine à travailler chaque mois sur le projet Duniter.
</p>
<p>
Voici l'état de nos finances ces derniers temps.
</p>
<iframe width="100%" class="autoHeight" src="https://growdfunding.borispaing.fr/iframe.php?target=1000&amp;title=les%20d%C3%A9veloppeurs%20de%20Duniter&amp;theme=tipeee&amp;unit=relative&amp;display_button=yes&amp;pubkey=78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8"></iframe>
<!--
<p>
<a href="{{ SITEURL }}/{% print(PAGE_URL.replace('{slug}', 'financements')) %}">
<img src="https://wotmap.duniter.org/iframe/image.php?&title={{ FUNDING_TITLE }}&target=625&unit=relative&pubkey={{ FUNDING_PUBKEY }}&border_color={{ FUNDING_BORDER_COLOR }}" />
</a>
</p>
<p>
Pour faire partie des mécènes de Duniter, c'est simple&nbsp;:
</p>
<div class="pubkey-and-copy-button">
<p class="pubkey">
Copiez la clef suivante&nbsp;:
<input class="pubkey" type="text" value="{{ FUNDING_PUBKEY }}" size="8" />...
dans votre presse-papier en cliquant sur le bouton ci-dessous :
</p>
<p>
<button class="copyButton">
Copier la clef
</button>
</p>
<div class="successMsg">
<p>Et maintenant collez-la dans votre client Duniter préféré (Cesium, Silkaj, etc.) afin de faire votre don 😉</p>
<p class="politeness-formula">Merci pour votre générosité ❤️</p>
<p class="author">Les développeurs de Duniter</p>
</div>
</div>
</div>
</section>
-->
<!--
<p class="back-to-top">
<a href="#">
{{ _('Retourner en haut') }}
</a>
</p>
-->
\ No newline at end of file
#!/usr/bin/env bash
#
## @file : develop_server.sh
## @brief : Script used to easily manage "Pelican" webserver
## @links :
## - Repository : https://github.com/duniter/website_fr
## - Wiki : https://duniter.org/fr/wiki/ameliorer-le-site
#
##
# This section should match your Makefile
##
PY=${PY:-python}
PELICAN=${PELICAN:-pelican}
PELICANOPTS=""
BASEDIR=$(pwd)
INPUTDIR=$BASEDIR/content
OUTPUTDIR=$BASEDIR/output
CONFFILE=$BASEDIR/pelicanconf.py
###
# Don't change stuff below here unless you are sure
###
SRV_PID=$BASEDIR/srv.pid
PELICAN_PID=$BASEDIR/pelican.pid
# Print message to user who needs help
function usage(){
echo "usage: $0 (stop) (start) (restart) [port]"
echo "This starts Pelican in debug and reload mode and then launches"
echo "an HTTP server to help site development. It doesn't read"
echo "your Pelican settings, so if you edit any paths in your Makefile"
echo "you will need to edit your settings as well."
exit 3
}
# Check if virtualenv is set before to start Pelican webserver
function check_venv(){
if [[ -z "$VIRTUAL_ENV" ]]
then
printf "%s\n" "Don't forget to setup your virtualenv !" "See REAME for more informations =)"
exit 1
fi
}
# Checking if process is running
function alive() {
kill -0 "$1" >/dev/null 2>&1
}
# Function used to stop HTTP server
function shut_down(){
check_venv
# Manage HTTP server
PID=$(cat "$SRV_PID" 2>/dev/null) # Hides output to users with stderr redirect
if [[ $? -eq 0 ]]; then
if alive "$PID"; then
echo "Stopping HTTP server"
kill "$PID"
else
echo "Stale PID, deleting"
fi
rm "$SRV_PID"
else
echo "HTTP server PIDFile not found"
fi
# Manage Pelican process
PID=$(cat "$PELICAN_PID" 2>/dev/null) # Hides output to users with stderr redirect
if [[ $? -eq 0 ]]; then
if alive "$PID"; then
echo "Killing Pelican"
echo "Your HTTP server is stopped !"
kill "$PID"
else
echo "Stale PID, deleting"
fi
rm "$PELICAN_PID"
else
echo "Pelican PIDFile not found"
echo "Check if your HTTP server is running !"
fi
}
# Function used to start HTTP server
function start_up(){
check_venv
local port=$1
echo "Starting up Pelican and HTTP server"
shift
$PELICAN --debug --autoreload -r "$INPUTDIR" -o "$OUTPUTDIR" -s "$CONFFILE" $PELICANOPTS &
pelican_pid=$!
echo $pelican_pid > "$PELICAN_PID"
cd "$OUTPUTDIR"
$PY -m pelican.server "$port" &
srv_pid=$!
echo $srv_pid > "$SRV_PID"
cd "$BASEDIR"
sleep 1
if ! alive $pelican_pid ; then
echo "Pelican didn't start. Is the Pelican package installed?"
return 1
elif ! alive $srv_pid ; then
echo "The HTTP server didn't start. Is there another service using port < $port > ?"
return 1
fi
echo 'Pelican and HTTP server processes now running in background.'
}
###
# MAIN
###
# Checking arguments passed to script
[[ ($# -eq 0) || ($# -gt 2) ]] && usage
# Default port number
DEFAULT_PORT=8556
# If necessary, set a default port number
if [[ (($1 == "start") || ($1 == "restart")) && (-z $2) ]]
then
printf "%s\n" "Don't forget to set a port number (default value : $DEFAULT_PORT)"
printf "%s\n" "If you want to overwrite this value :" "* Don't forget to set port number (see usage)" "* Don't forget to edit pelicanconf.py file (SITEURL value)"
exit 1
else
port=$2
fi
# Parse arguments and execute program
if [[ $1 == "stop" ]]; then
shut_down
elif [[ $1 == "restart" ]]; then
shut_down
start_up "$port"
elif [[ $1 == "start" ]]; then
if ! start_up "$port"; then
shut_down
fi
else
usage
fi
<section id="CTA-develloper" class="container{% if BOOTSTRAP_FLUID %}-fluid{% endif %}">
<div>
<h2>Vous êtes développeur ?</h2>
<p>
Vous avez des questions qui n'ont pas trouvé réponse sur ce site ?
</p>
<p>
Vous aimeriez savoir comment vous pouvez contribuer ?
</p>
<p>
<a href="https://forum.duniter.org/c/presentations" class="CTA">
Présentez-vous sur le forum
</a>
</p>
</div>
</section>
<!--
<section id="thx">
<div>
<h2><strong>Merci</strong> <span>à nos mécènes</span> <span>du mois dernier :</span></h2>
<iframe width="100%" class="autoHeight" src="https://growdfunding.borispaing.fr/iframe.php?target=1000&amp;title=les%20développeurs%20de%20Duniter&amp;theme=cloud&amp;unit=relative&amp;start_date=2020-01-01&amp;end_date=2020-01-31&amp;pubkey=78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8"></iframe>
</div>
</section>
<section class="support">
<div>
<h2>Financez les développeurs</h2>
<p>
Duniter est <a href="{{ SITEURL }}/{% print(PAGE_URL.replace('{slug}', 'financements')) %}">financé par ses utilisateurs</a>.
</p>
<p>
Les dons servent à indemniser le travail des différents contributeurs (développeurs, traducteurs, graphistes, etc.).
Nous sommes une vingtaine à travailler chaque mois sur le projet Duniter.
</p>
<p>
Voici l'état de nos finances ces derniers temps.
</p>
<iframe width="100%" class="autoHeight" src="https://growdfunding.borispaing.fr/iframe.php?target=1000&amp;title=les%20d%C3%A9veloppeurs%20de%20Duniter&amp;theme=tipeee&amp;unit=relative&amp;display_button=yes&amp;pubkey=78ZwwgpgdH5uLZLbThUQH7LKwPgjMunYfLiCfUCySkM8"></iframe>
<!--
<p>
<a href="{{ SITEURL }}/{% print(PAGE_URL.replace('{slug}', 'financements')) %}">
<img src="https://wotmap.duniter.org/iframe/image.php?&title={{ FUNDING_TITLE }}&target=625&unit=relative&pubkey={{ FUNDING_PUBKEY }}&border_color={{ FUNDING_BORDER_COLOR }}" />
</a>
</p>
<p>
Pour faire partie des mécènes de Duniter, c'est simple&nbsp;:
</p>
<div class="pubkey-and-copy-button">
<p class="pubkey">
Copiez la clef suivante&nbsp;:
<input class="pubkey" type="text" value="{{ FUNDING_PUBKEY }}" size="8" />...
dans votre presse-papier en cliquant sur le bouton ci-dessous :
</p>
<p>
<button class="copyButton">
Copier la clef
</button>
</p>
<div class="successMsg">
<p>Et maintenant collez-la dans votre client Duniter préféré (Cesium, Silkaj, etc.) afin de faire votre don 😉</p>
<p class="politeness-formula">Merci pour votre générosité ❤️</p>
<p class="author">Les développeurs de Duniter</p>
</div>
</div>
</div>
</section>
-->
<footer class="container{% if BOOTSTRAP_FLUID %}-fluid{% endif %}">
<div>
......@@ -182,15 +99,6 @@
</nav>
<!--
<p class="back-to-top">
<a href="#">
{{ _('Retourner en haut') }}
</a>
</p>
-->
{#
<p id="generator">
{% if articles %}
......
rewrite ^/votre-page.html$ http://www.votre-domaine.com/nouvelle-page.html permanent;
/a-propos/ => /qui-sommes-nous/
/wiki/* => *
/contribuer/ => /contribuer-au-code/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment