Update README
This commit is contained in:
parent
43bc3eeac0
commit
4b6595b4a3
29
CHANGELOG.md
29
CHANGELOG.md
|
|
@ -5,34 +5,9 @@ Tyto - Littérateur
|
||||||
- Issues: https://git.a-lec.org/echolib/tyto-litterateur/-/issues
|
- Issues: https://git.a-lec.org/echolib/tyto-litterateur/-/issues
|
||||||
- Changelog: https://git.a-lec.org/echolib/tyto-litterateur/-/blob/master/CHANGELOG.md
|
- Changelog: https://git.a-lec.org/echolib/tyto-litterateur/-/blob/master/CHANGELOG.md
|
||||||
- License: https://git.a-lec.org/echolib/tyto-litterateur/-/blob/master/LICENSE
|
- License: https://git.a-lec.org/echolib/tyto-litterateur/-/blob/master/LICENSE
|
||||||
|
- Documentation: https://tyto.echolib.re
|
||||||
|
|
||||||
## {0.10.4]
|
## [0.10.6]
|
||||||
- pre 1.0
|
|
||||||
- Added some variables in domain config
|
|
||||||
- creating with tyto new filename ensure unicode
|
|
||||||
- Other fixes
|
|
||||||
|
|
||||||
## [0.10.2]
|
|
||||||
- Cite in a text > `[_` + `_]`
|
|
||||||
- Italic `<em>` > `;_` + `_;`
|
|
||||||
- Italic `<i>` > {_:_` + `_:`
|
|
||||||
|
|
||||||
## [0.10.1]
|
|
||||||
- Fix with try in check for static page
|
|
||||||
|
|
||||||
## [0.10.0]
|
|
||||||
- Add full static page option (--static) only with wip
|
|
||||||
- Add <div> markers: `<<`, `>>`
|
|
||||||
- Add new container <div> in footer
|
|
||||||
- Better status display for article
|
|
||||||
- fix lang setting
|
|
||||||
- fix for less warnings in HTML validity
|
|
||||||
|
|
||||||
## [0.9.1]
|
|
||||||
- wip: tabulation when using `<hr />`
|
|
||||||
- wip: inline quote markers `@_myquote_@`
|
|
||||||
- wip: inline italic marker `:_maybe_:`
|
|
||||||
- wip: fix data retreive in complete quote
|
|
||||||
|
|
||||||
## [0.9.0]
|
|
||||||
- Last testings before final
|
|
||||||
|
|
|
||||||
251
README.md
251
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# Tyto
|
# Tyto
|
||||||
Pour obtenir de l'aide, taper juste la commande tyto
|
- FR. Pour obtenir de l'aide, taper juste la commande tyto
|
||||||
|
- EN. To get help, just type tyto.
|
||||||
|
- - Doc is only in french yet, but Tyto is translated, also for your websites
|
||||||
|
|
||||||
## Répertoire de code du projet Tyto
|
## Répertoire de code du projet Tyto
|
||||||
https://git.a-lec.org/echolib/tyto-litterateur
|
https://git.a-lec.org/echolib/tyto-litterateur
|
||||||
|
|
@ -7,234 +9,45 @@ https://git.a-lec.org/echolib/tyto-litterateur
|
||||||
## Documentation officielle
|
## Documentation officielle
|
||||||
https://tyto.echolib.re (en cours de construction)
|
https://tyto.echolib.re (en cours de construction)
|
||||||
|
|
||||||
## Démarrage "rapide"
|
## Créer un domaine
|
||||||
````
|
````
|
||||||
mkdir -p MONDOMAIN
|
mkdir -p MONDOMAIN
|
||||||
cd MONDOMAIN
|
cd MONDOMAIN
|
||||||
tyto new domain URL
|
tyto new domain URL
|
||||||
tyto new index
|
````
|
||||||
|
|
||||||
# À ce stade, voir la doc "écrire"
|
# Créer un article
|
||||||
|
https://tyto.echolib.re/%C3%A9crire/
|
||||||
|
```
|
||||||
|
cd articles/
|
||||||
|
tyto new index
|
||||||
tyto edit index.tyto
|
tyto edit index.tyto
|
||||||
|
```
|
||||||
|
|
||||||
|
# Vérifier, prévisualiser un article
|
||||||
|
```
|
||||||
tyto check index.tyto
|
tyto check index.tyto
|
||||||
tyto wip index.tyto
|
tyto wip index.tyto
|
||||||
|
```
|
||||||
|
|
||||||
|
# Les modules
|
||||||
|
https://tyto.echolib.re/usages/modules.html
|
||||||
|
|
||||||
|
La barre latérale, le menu, le pied de page et les balises génériques metas
|
||||||
|
ne seront pas visible localement sans serveur nginx.
|
||||||
|
|
||||||
|
Utiliser l'option --static avec la commande wip pour les voir. Attention,
|
||||||
|
utiliser la commande publish après avoir utilisé l'option --static sur wip
|
||||||
|
mettra en ligne la version statique de la page. Il faut donc avant la
|
||||||
|
commande publish, recommencer la commande wip sur un article sans l'option
|
||||||
|
--static pour utiliser l'include de nginx (comportement par défaut)
|
||||||
|
|
||||||
|
|
||||||
# Publier !
|
# Publier !
|
||||||
|
```
|
||||||
|
# La première fois, ou après mise à jour des modules ou des fichiers (logo, css...)
|
||||||
tyto publish template
|
tyto publish template
|
||||||
|
|
||||||
|
# Mettre dans le dossier "www" officiel
|
||||||
tyto publish index.tyto
|
tyto publish index.tyto
|
||||||
```
|
```
|
||||||
|
|
||||||
## Comment définir les métas
|
|
||||||
```
|
|
||||||
# Obligatoires uniques
|
|
||||||
# Ces marqueurs se configurent sur UNE ligne
|
|
||||||
title: Titre
|
|
||||||
about: Infos de l'article
|
|
||||||
author: Auteur
|
|
||||||
tags: mot-clé-1,mot 2,
|
|
||||||
date: YYYY-MM-DD (AAAA-MM-JJ)
|
|
||||||
|
|
||||||
# Pour snpic, l'image doit être configurée avec le même Nom
|
|
||||||
# qu'un marqueur d'entête "image:"
|
|
||||||
# Utilise l'image précisée comme "avatar" dans les réseaux sociaux
|
|
||||||
# Et dans le flux RSS
|
|
||||||
snpic: Nom
|
|
||||||
|
|
||||||
|
|
||||||
# Optionnels multiples
|
|
||||||
# Ces marqueurs se configurent sur 3 lignes
|
|
||||||
link: Nom du lien
|
|
||||||
URL
|
|
||||||
Texte Alternatif
|
|
||||||
|
|
||||||
image: Nom
|
|
||||||
URI
|
|
||||||
Texte Alternatif
|
|
||||||
|
|
||||||
file: Nom du lien
|
|
||||||
URL
|
|
||||||
Texte Alternatif
|
|
||||||
|
|
||||||
raw: Nom
|
|
||||||
URI
|
|
||||||
Texte Alternatif
|
|
||||||
|
|
||||||
abbr: abbrev
|
|
||||||
Définition de abbrev
|
|
||||||
ABBR (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
|
|
||||||
----------
|
|
||||||
```
|
|
||||||
|
|
||||||
## Comment écrire un article
|
|
||||||
|
|
||||||
### Écrire des titres
|
|
||||||
```
|
|
||||||
# Les titres HTML vont de 1 à 6 mais h1 est utilisé pour afficher
|
|
||||||
# le titre de l'article.
|
|
||||||
# Utiliser #N, où N est entre 1 et 5. (h+1 en HTML)
|
|
||||||
# Si du contenu existe entre les titres, une <div> est ajoutée
|
|
||||||
|
|
||||||
# Source
|
|
||||||
#1 Titre 1
|
|
||||||
Contenu 1
|
|
||||||
|
|
||||||
#2 Titre 2
|
|
||||||
|
|
||||||
#3 Titre 3
|
|
||||||
contenu 2
|
|
||||||
|
|
||||||
#4 Titre 4
|
|
||||||
```
|
|
||||||
|
|
||||||
### Balise div
|
|
||||||
```
|
|
||||||
<< CSS
|
|
||||||
((
|
|
||||||
1er paragraphes dans une balise div class="CSS"
|
|
||||||
))
|
|
||||||
((
|
|
||||||
2e paragraphes dans une balise div class="CSS"
|
|
||||||
))
|
|
||||||
>>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Paragraphes
|
|
||||||
```
|
|
||||||
(( CSS
|
|
||||||
Un paragraphe
|
|
||||||
))
|
|
||||||
```
|
|
||||||
|
|
||||||
### Code Brut
|
|
||||||
```
|
|
||||||
{{ CSS
|
|
||||||
def hello_world():
|
|
||||||
print("Hello")
|
|
||||||
}}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Listes ul/ol
|
|
||||||
```
|
|
||||||
-( CSS
|
|
||||||
= Liste ul
|
|
||||||
== Sous-liste ul
|
|
||||||
=== Sous-sous-liste ul
|
|
||||||
++++ Sous-sous-sous-liste ol
|
|
||||||
+++ Sous-sous-liste ol
|
|
||||||
-)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ancres
|
|
||||||
```
|
|
||||||
# Source de l'ancre cible. "id" est son identité
|
|
||||||
-> id
|
|
||||||
|
|
||||||
# Source de l'ancre d'appel
|
|
||||||
# Définir l'identité cible et le texte du lien
|
|
||||||
>_id:Retourner au point d'ancre id_<
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Retour à la ligne HTML
|
|
||||||
```
|
|
||||||
# Source
|
|
||||||
|
|
|
||||||
|
|
||||||
# HTML
|
|
||||||
<br />
|
|
||||||
```
|
|
||||||
|
|
||||||
### Lien vers URL
|
|
||||||
```
|
|
||||||
# Placer "_" devant le Nom du lien
|
|
||||||
Voir ce _Nom du lien # Ouverture même fenêtre
|
|
||||||
Voir ce _Nom du lien+ # ouverture nouvelle fenêtre
|
|
||||||
```
|
|
||||||
|
|
||||||
### Lien vers fichier
|
|
||||||
```
|
|
||||||
# Placer "__" devant le Nom du lien
|
|
||||||
Voir ce __Nom du lien # Ouverture même fenêtre
|
|
||||||
Voir ce __Nom du lien+ # ouverture nouvelle fenêtre
|
|
||||||
```
|
|
||||||
|
|
||||||
Note:
|
|
||||||
Vous pouvez avoir un Nom identique pour les marqueurs `file:` et `link:`
|
|
||||||
|
|
||||||
|
|
||||||
### Gras, Strong, italique...
|
|
||||||
```
|
|
||||||
*_très gras_* # <strong>
|
|
||||||
+_gras léger_+ # <b>
|
|
||||||
;_en italique_; # <em>
|
|
||||||
:_en italique_: # <i>
|
|
||||||
~_texte barré_~ # <del>
|
|
||||||
[_Citation rapide_] # <cite>
|
|
||||||
%_Classe personnalisée_% >>> <span class="custom">
|
|
||||||
._Souligné_. # <u>
|
|
||||||
{_Code_} # <code>
|
|
||||||
|
|
||||||
# Montrer comment écrire du code dans Tyto:
|
|
||||||
# Bypass avec \ devant {_ et _}
|
|
||||||
{_\{_Comme ça\_}_}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Abréviations
|
|
||||||
```
|
|
||||||
# abbrev sera remplacé par "ABBR" dans la page si défini en entête
|
|
||||||
# sinon, abbrev sera conservé
|
|
||||||
# - Toujours écrire dans l'article :
|
|
||||||
# - entre parenthèses ET majuscules les "(ABBREV)"
|
|
||||||
|
|
||||||
|
|
||||||
Avec cette (ABBREV).
|
|
||||||
# HTML: <abbr title="Définition de abbrev">ABBR</abbr>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Images
|
|
||||||
```
|
|
||||||
# Chaque image doit être placée en début de ligne
|
|
||||||
# Placer dans un paragraphe pour chacune ou après "|",
|
|
||||||
# sinon, affichage les une à côté des autres
|
|
||||||
# ! Si pas d'unité pour w= et h= : défaut "px"
|
|
||||||
|
|
||||||
_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 web à l'image
|
|
||||||
_image:Nom c=CSS t=https://... w=320px h=240 # 240px
|
|
||||||
```
|
|
||||||
|
|
||||||
### Code brut depuis un fichier
|
|
||||||
```
|
|
||||||
_raw:Nom
|
|
||||||
```
|
|
||||||
|
|
||||||
### Citations
|
|
||||||
Possibilité dans toute citation d'utiliser les marqueurs
|
|
||||||
optionnels `_xxx:`. Pour la date, utilisez le FORMAT INTERNATIONAL
|
|
||||||
```
|
|
||||||
# Source: citation complète
|
|
||||||
[[ CSS_TEST
|
|
||||||
_cite: echolib
|
|
||||||
_date: 2022-12-28 (format AAAA ou AAAA-MM ou AAAA-MM-JJ)
|
|
||||||
_lang: fr
|
|
||||||
_link: https://tyto.echolib.re
|
|
||||||
_book: Référence
|
|
||||||
((
|
|
||||||
Pfff, vraiment !
|
|
||||||
))
|
|
||||||
]]
|
|
||||||
````
|
|
||||||
```
|
|
||||||
# Source: citation basique
|
|
||||||
[[
|
|
||||||
Une citation simple, et sans paragraphe
|
|
||||||
]]
|
|
||||||
```
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue