tyto-litterateur/README.md

134 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

2023-12-30 18:52:52 +01:00
# This software needs tests !
This program can be tested and should mainly work. Please report any problems
2023-12-28 00:31:19 +01:00
Tyto - Littérateur is translated in french and english.
2024-03-10 15:47:59 +01:00
Official website not yet udpated for this new version. Current website
documentation is in directory source (/usr/share/tyto/docs/www/)
2022-11-16 11:45:39 +01:00
2023-09-22 11:52:44 +02:00
# Commands
2022-11-26 12:34:59 +01:00
```
2023-12-28 00:31:19 +01:00
# Get commands help
2023-09-22 11:52:44 +02:00
tyto
2023-12-28 00:31:19 +01:00
# Get all documentation
tyto help all
# How to write words tags (strong...) and anchors
tyto help words anchor
2022-11-26 12:34:59 +01:00
```
2023-12-28 00:31:19 +01:00
# Create new domain
2023-11-10 02:56:50 +01:00
- create a domain directory, like www.domain.tld
2024-01-02 15:01:52 +01:00
- go to this directory
- type `tyto new domain`
- type `tyto check domain` and PLEASE, CHECK configuration file
2024-01-02 15:01:52 +01:00
# Create an article
- go to domain directory ".../articles/"
- create an article file [myfile].tyto (see `tyto help article`)
- type `tyto wip myfile.tyto`
- [myfile].html is created in wip/ domain server directory
2023-03-07 17:49:50 +01:00
## Exemple d'article .tyto commenté
2023-10-26 18:59:56 +02:00
```
2023-12-28 00:31:19 +01:00
title: Tests
about: Tests divers
date: 2023-02-28
tags: tests
authors: echolib
2024-03-10 15:47:59 +01:00
# Ajouter l'URI d'une image "logo" de l'article
#logo: @logos/post_logo_test.png
2023-12-28 00:31:19 +01:00
abbr: CSS
Cascading SteelSheet
en
2023-12-28 00:31:19 +01:00
link: le site est prêt
https://forge.a-lec.org
La forge libre
2023-12-31 12:14:35 +01:00
code: MyPY
@code1.py
Test d'ajout de code depuis un fichier
2024-01-01 16:44:28 +01:00
file: PyF
@code1.py
Lien vers un fichier
2023-10-27 17:40:10 +02:00
-----
2023-12-31 12:14:35 +01:00
! TOC
2023-10-26 18:59:56 +02:00
2023-12-28 00:31:19 +01:00
#1 Titre 1
((
Un peu de ::CSS et ::le site est prêt
(( note
Cet article est un test
))
))
2023-10-26 18:59:56 +02:00
2023-12-28 00:31:19 +01:00
#2 Citation
("
cite: Auteur
date: AAAA-MM-JJ
book: Nom du livre
lang: fr
link: https://...
2023-10-27 17:40:10 +02:00
2023-10-26 18:59:56 +02:00
((
2023-12-28 00:31:19 +01:00
Citation complète dans un paragraphe
2023-10-26 18:59:56 +02:00
))
2023-12-28 00:31:19 +01:00
)"
2023-10-26 18:59:56 +02:00
2023-12-28 00:31:19 +01:00
#2 Code (bloc)
2024-01-01 16:44:28 +01:00
{{
2023-12-28 00:31:19 +01:00
# Écrire les marqueurs de mots
2024-03-10 15:47:59 +01:00
# Chaque marqueur à la classe CSS de la configuration du domaine
2023-12-28 00:31:19 +01:00
# Astuce : ** + ← + `` + ← + très gras
2023-12-28 00:31:19 +01:00
*`très gras`* => <strong>
+`gras`+ => <b>
/`italique`/ => <em>
;`italique`; => <i>
_`souligné`_ => <u>
~`effacé`~ => <del>
[`cité`] => <q> # Contenu
:`cité`: => <cite> # auteur, nom
|`perso`| => <span>
# Code dans un texte
# ! Les marqueurs d'ouverture et de fermeture de code sont sur la MEME LIGNE
2024-01-02 15:01:52 +01:00
{` <li>Une entrée de liste</li> `} => <code>
2023-12-28 00:31:19 +01:00
# ! Dans certains cas, il faut ajouter un espace après le 1er marqueur
# et/ou avant le second. Ils seront automatiquement supprimés
*`DOMAIN/articles/ `* # évite /` : marqueur italique ouvert
}}
2023-11-13 18:04:12 +01:00
2023-12-28 00:31:19 +01:00
#2 Une liste
# Liste. Classe CSS possible (défaut : celle dans la configuration)
# Une entrée de liste peut être ordonnée avec le signe "+" ou non avec "="
# Une liste peut contenir des entrées mixées ("+" et "=")
# mais au changement de signe, ajouter un signe !
# Possible d'écrire une entrée sur plusieurs lignes
(=
= Première entrée non ordonnée (ul)
== Sous entrée non ordonnée
+++ Première sous-sous entrée ordonnée (ol)
+++ Seconde sous-sous entrée ordonnée
= Seconde entrée non ordonnée
= Troisième entrée ...
... non ordonnée
)=
2023-12-31 12:14:35 +01:00
::MyPY
2024-01-18 11:17:30 +01:00
((
Télécharger le fichier ::PyF.
2024-03-10 15:47:59 +01:00
Ceci est un icode : {` <h1>Titre principal de l'article</h1> `}
2024-01-18 11:17:30 +01:00
))
2023-10-26 18:59:56 +02:00
```