Readme
This commit is contained in:
parent
fc1c059fda
commit
b8ddd56662
|
|
@ -1,21 +0,0 @@
|
|||
# Installation manuelle
|
||||
|
||||
Si vous utilisez Debian, il est plus que recommandé de procéder à
|
||||
l'installation par le paquet .deb
|
||||
|
||||
## Préparer les dossiers
|
||||
````
|
||||
sudo mkdir -p /var/lib/tyto /etc/tyto /var/log/tyto
|
||||
sudo touch /usr/local/bin/tyto
|
||||
sudo chown -R USER:GROUP /var/lib/tyto /etc/tyto /var/log/tyto
|
||||
sudo chown USER:GROUP /usr/local/bin/tyto
|
||||
sudo chmod +x /usr/local/bin/tyto
|
||||
|
||||
git clone https://git.a-lec.org/echolib/tyto
|
||||
rsync -a folders'repo/ to /folders/
|
||||
|
||||
# Créer votre dossier pour le serveur web
|
||||
# On utilise en général /var/www/
|
||||
# Celui-ci sera à renseigner lors de la création d'un domaine dans Tyto
|
||||
sudo mkdir -p /var/www/
|
||||
````
|
||||
|
|
@ -1,180 +1,166 @@
|
|||
# STL: Statique Littérateur
|
||||
STL est une évolution du projet GSL. STL permet de créer un ou plusieurs
|
||||
sites web/blogs statiques, en fonction de leur nom de domaine.
|
||||
# Tyto
|
||||
|
||||
Tout comme GSL, STL reprend une grande partie de l'écriture nouvelle de
|
||||
vos articles, en apportant quelques évolutions. Les articles sont donc
|
||||
au format .stl.
|
||||
|
||||
|
||||
# Fonctionnement de STL ; le dossier de base
|
||||
Contrairement à GSL, vos articles et les pages de votre site web sont
|
||||
situés dans le même dossier de base. Pour obtenir ce dossier de base,
|
||||
et configurer votre domaine, vous devez d'abord vous placer dans le
|
||||
dossier de votre choix, puis lancer la commande de configuration.
|
||||
## Répertoire de code du projet Tyto
|
||||
|
||||
## Comment définir les métas
|
||||
```
|
||||
cd MON-DOSSIER-PREFERE
|
||||
stl domain new
|
||||
# Obligatoires uniques
|
||||
title: Titre
|
||||
about: Infos de l'article
|
||||
author: Autheur
|
||||
tags: mots-clé-1,mots-clé-2
|
||||
date: YYYY-MM-DD (AAAA-MM-JJ)
|
||||
|
||||
# Vous pouvez également pré-remplir votre domaine en fonction de l'URL
|
||||
stl domain new https://mon-site.xyz
|
||||
# Optionnels myltiples
|
||||
link: Nom du lien
|
||||
URL
|
||||
Texte Alternatif
|
||||
|
||||
image: Nom
|
||||
URI
|
||||
Texte Alternatif
|
||||
|
||||
file: Nom du lien
|
||||
URL
|
||||
Texte Alternatif
|
||||
|
||||
brut: Nom
|
||||
URI
|
||||
Texte Alternatif
|
||||
|
||||
abbr: NOM (en majuscule)
|
||||
Définition du NOM
|
||||
nom (forme à afficher dans l'artile (optionnel))
|
||||
|
||||
# Séparateur d'au moins 5 "-" pour définir la fin
|
||||
# des métadonnées d'entête de l'article
|
||||
----------
|
||||
```
|
||||
|
||||
Dans ce dossier de base (MON-DOSSIER-PREFERE), après la configuration de
|
||||
votre domaine, vous trouverez de nouveaux dossiers :
|
||||
- articles/
|
||||
- - images/
|
||||
- - files/
|
||||
|
||||
Les sous-dossiers images/ et files/ sont proposés afin de faciliter la
|
||||
réutilisation d'images et de fichiers (PDF, ou autres) déjà présents
|
||||
dans un autre article. Lors de la synchronisation, il seront copiés à la
|
||||
racine wip de votre serveur. Le but : faire en sorte que le
|
||||
navigateur n'ait pas à recharger un même fichier depuis une URL
|
||||
différente - ce qui plomberait la rapidité d'affichage de la page et
|
||||
l'intérêt d'un site statique. L'utilisation de cette fonction dans vos
|
||||
articles est simple ; voir la documentation expliquant comment écrire un
|
||||
article dans le dossier help.
|
||||
|
||||
Dans le dossier du serveur (/var/www est un exemple), vous trouverez
|
||||
les dossiers suivants :
|
||||
- /var/www/DOMAIN/wip/
|
||||
- - template (logos, styles.css, sidebar.html, footer.html, metas.html...)
|
||||
- - images
|
||||
- - files
|
||||
- /var/www/DOMAIN/www/ (non créé pour une installation locale)
|
||||
- - template/
|
||||
- - images
|
||||
- - files
|
||||
|
||||
|
||||
## Installation (server, ou local)
|
||||
Il est possible d'utiliser STL de 2 manières différentes. Lors de la
|
||||
configuation d'un nouveau domaine, vous devrez choisir entre une
|
||||
installation faite sur un serveur distant, et une installation faite
|
||||
en local (sur votre PC). Vous pouvez bien sûr choisir une installation
|
||||
de type "server" sur votre PC, si celui-ci sert de serveur web.
|
||||
|
||||
Concernant la décoration du site (styles.css, logos), les fichiers
|
||||
devront être placés dans le dossier serveur /wip/template/ (créé par STL
|
||||
lors de l'ajout d'un domaine).
|
||||
|
||||
|
||||
### Installation "server"
|
||||
À choisir si votre PC sert de serveur web, ou si vous avez installé STL
|
||||
sur votre serveur distant.
|
||||
|
||||
Lorsque vous installez STL, sur votre serveur distant, vous pouvez gérer
|
||||
pour un même nom de domaine, votre site sur 2 adresses URL différentes.
|
||||
La version WIP, permet de prévisualiser les modifications apportées à
|
||||
vos pages (sans modifier celles sur WWW) avant de les valider sur votre
|
||||
site officiel.
|
||||
|
||||
Lorsque votre site prévisualisé sur WIP vous plaît, vous pouvez alors
|
||||
synchroniser le dossier WIP sur WWW grâce à la commande :
|
||||
|
||||
## Comment écrire un article
|
||||
### Titre h1 à h6
|
||||
```
|
||||
# Pour publier un article précis
|
||||
stl publish (ARTICLE)
|
||||
#1 Titre 1
|
||||
((
|
||||
Un paragraphe
|
||||
))
|
||||
|
||||
# Pour publier tous les articles dans WIP
|
||||
stl publish all
|
||||
#2 Titre 2
|
||||
```
|
||||
|
||||
Note : cette commande crée automatiquement le flux RSS dans WIP avant
|
||||
de tous synchroniser sur WWW.
|
||||
|
||||
|
||||
### Installation "local"
|
||||
À choisir si vous voulez utiliser STL sur votre PC, et synchroniser
|
||||
vous-même le dossier WIP sur votre serveur distant. Inutile donc,
|
||||
d'installer STL sur le serveur distant.
|
||||
|
||||
Lors d'une utilisation locale, STL ne crée pas le dossier WWW, et ne
|
||||
synchronise donc pas le dossier WIP vers WWW. C'est à vous de le faire
|
||||
(via ssh, par exemple).
|
||||
|
||||
Vous devrez lorsque votre site vous plaît localement lancer la création
|
||||
du flux RSS - avant de synchroniser votre site local sur votre serveur
|
||||
distant - avec la commande :
|
||||
|
||||
### Paragraphes
|
||||
```
|
||||
stl rss
|
||||
(( CSS
|
||||
Un paragraphe
|
||||
))
|
||||
```
|
||||
|
||||
|
||||
# Utilisation de STL
|
||||
Afin de gérer vos articles, vous devez vous placer dans MON-DOSSIER-PREFERE.
|
||||
L'autocomplétion est activée et personnalisée pour vous aider à trouver
|
||||
(ARTICLE.stl).
|
||||
|
||||
|
||||
## Créer votre arborescence
|
||||
Dans MON-DOSSIER-PREFERE, vous trouverez le dossier "articles". Celui-ci
|
||||
sert de base à votre domain.xyz sur votre serveur. C'est dans ce dossier
|
||||
"articles", que vous pouvez créer vos articles et vos sous-dossiers.
|
||||
Il est à noter que le nom de l'article est important, puisque STL
|
||||
l'utilisera en le transformant en .html. Il est donc recommandé - mais
|
||||
pas obligatoire - de nommer vos articles index.stl, pour obtenir une page
|
||||
index.html. Si vous voulez créer une page 404, nommez votre article 404.stl
|
||||
à la racine du dossier "articles".
|
||||
|
||||
|
||||
## Convertir votre article en HTML
|
||||
Placez vous dans MON-DOSSIER-PREFERE.
|
||||
|
||||
Avant de pouvoir convertir votre article, STL dispose d'un système de
|
||||
vérification de la syntaxe STL. Si des erreurs sont trouvées, un système
|
||||
de logs vous aidera à corriger ces erreurs.
|
||||
|
||||
### Code Brut
|
||||
```
|
||||
# N'oubliez pas d'utiliser l'autocomplétion
|
||||
stl check (ARTICLE.stl)
|
||||
{{ CSS
|
||||
def hello_world():
|
||||
print("Hello")
|
||||
}}
|
||||
```
|
||||
|
||||
Vous pouvez maintenant le convertir en HTML dans le dossier wip
|
||||
|
||||
### Listes ul/ol
|
||||
```
|
||||
stl wip (ARTICLE.stl)
|
||||
-( CSS
|
||||
= Liste ul
|
||||
== Sous-liste ul
|
||||
=== Sous-sous-liste ul
|
||||
++++ Sous-sous-sous-liste ol
|
||||
+++ Sous-sous-liste ol
|
||||
-)
|
||||
```
|
||||
|
||||
|
||||
## Utiliser la sidebar
|
||||
C'est la seule partie du site qui est semi-statique. STL fait appel à
|
||||
nginx, qui va se charger de traduire la balise HTML `<!--# include file="..." -->`,
|
||||
et afficher le rendu du fichier sidebar.html
|
||||
|
||||
Chaque article, une fois convertit avec l'argument wip peut être placé
|
||||
dans la sidebar à la position désirée, entre 1 et la valeur maximum
|
||||
décidée, lors de la configuration du domaine.
|
||||
|
||||
### Citations
|
||||
```
|
||||
stl sidebar add 1 (ARTICLE.stl)
|
||||
[[ CSS
|
||||
_cite: autheur
|
||||
_lang: langue
|
||||
_link: lien
|
||||
_year: année ou date YYYY-MM-DD
|
||||
_book: référence
|
||||
((
|
||||
Citation placée dans un paragraphe
|
||||
))
|
||||
]]
|
||||
|
||||
[[ CSS
|
||||
Citation simple sans référence
|
||||
]]
|
||||
```
|
||||
|
||||
Vous pouvez également décider de placer un article ausitôt convertit
|
||||
avec l'argument wip sidebar=POSITON
|
||||
|
||||
### Ancres
|
||||
```
|
||||
stl wip sidebar=2 (ARTICLE.stl)
|
||||
-> id
|
||||
((
|
||||
un long paragraphe
|
||||
))
|
||||
((
|
||||
>_id:Retourner au point d'ancre_<
|
||||
))
|
||||
```
|
||||
|
||||
## Documentation de STL
|
||||
Les fichiers de documentations sont dans le dossier help.
|
||||
Le README est accessible depuis la ligne de commande, comme les arguments
|
||||
utilisables.
|
||||
|
||||
### Retour à la ligne HTML
|
||||
```
|
||||
stl help
|
||||
stl readme
|
||||
| # <br />
|
||||
```
|
||||
|
||||
### Lien vers URL
|
||||
```
|
||||
Voir ce _Nom du lien # Ouverture même fenêtre
|
||||
Voir ce _Nom du lien+ # ouverture nouvelle fenêtre
|
||||
```
|
||||
|
||||
## Dépendances
|
||||
STL est écrit en bash, et a besoin des utilitaires
|
||||
- gawk
|
||||
- rsync
|
||||
- nano
|
||||
- curl
|
||||
### Lien vers fichier
|
||||
```
|
||||
Voir ce __Nom du lien # Ouverture même fenêtre
|
||||
Voir ce __Nom du lien+ # ouverture nouvelle fenêtre
|
||||
```
|
||||
|
||||
Note:
|
||||
Vous pouvez avoir un NAME identique pour file: et link:
|
||||
|
||||
### Gras, Strong, italique...
|
||||
```
|
||||
*_très gras_* # <strong>
|
||||
+_gras léger_+ # <b>
|
||||
/_en italique_/ # <em>
|
||||
[_en italique_] # <i>
|
||||
~_texte barré_~ # <del>
|
||||
{_Code_} # <code>
|
||||
:_Citation rapide_: # <cite>
|
||||
%_Classe personnalisée_% >>> <span class="custom">
|
||||
._Souligné_. # <u>
|
||||
|
||||
```
|
||||
|
||||
### Abréviations
|
||||
```
|
||||
# ! NOM sera remplacé par "nom" dans la page si défini en entête
|
||||
# sinon, NOM sera conservé
|
||||
# Toujours écrire en majuscule les ABBR dans l'article brut
|
||||
# <abbr title="Définition du NOM">nom</abbr>
|
||||
Avec ce NOM.
|
||||
```
|
||||
|
||||
### Images
|
||||
```
|
||||
# Chaque image doit être placée en début de ligne
|
||||
# Placer en paragraphe pour chaque ou après "|" sinon,
|
||||
# affichage les une à côté des autres
|
||||
_image:NOM
|
||||
_image:NOM c=CSS
|
||||
_image:NOM c=css w=1080
|
||||
_image:NOM w=640em h=480em
|
||||
_image:NOM t=+ # Rend l'image interne cliquable
|
||||
_image:NOM t=https://...# Donne un lien à l'image
|
||||
_image:NOM c=CSS t=https://... w=320px h=240
|
||||
```
|
||||
|
||||
### Code Brut depuis un fichier
|
||||
```
|
||||
_brut:NOM
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue