echolib/tyto-litterateur
echolib
/
tyto-litterateur
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
tyto-litterateur/README.md

237 lines
7.9 KiB
Markdown
Raw Blame History

# This software needs tests !
This program can be tested and should mainly work. Please report any problems
Tyto - Littérateur is translated in french and english.
Official website not yet udpated for this new version.
# Commands
```
# Get commands help
tyto
# Get all documentation
tyto help all
# How to write words tags (strong...) and anchors
tyto help words anchor
```
# Create new domain
- create a domain directory, like www.domain.tld
- go to this directory
- type `tyto new domain`
- type `tyto check domain` and PLEASE, CHECK configuration file
# 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
## Exemple d'article .tyto commenté
```
title: Tests
about: Tests divers
date: 2023-02-28
tags: tests
authors: echolib
abbr: CSS
Cascading SteelSheet
en
link: le site est prêt
https://forge.a-lec.org
La forge libre
code: MyPY
@code1.py
Test d'ajout de code depuis un fichier
file: PyF
@code1.py
Lien vers un fichier
-----
! TOC
#1 Titre 1
((
Un peu de ::CSS et ::le site est prêt
(( note
Cet article est un test
))
))
#2 Citation
("
cite: Auteur
date: AAAA-MM-JJ
book: Nom du livre
lang: fr
link: https://...
((
Citation complète dans un paragraphe
))
)"
#2 Code (bloc)
{{
# Écrire les marqueurs de mots
# Chaque marqueur à la classe CSS de la configuration
# Astuce : ** + ← + `` + ← + très gras
*`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
{` <li>Une entrée de liste</li> `} => <code>
# ! 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
}}
#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
)=
::MyPY
Télécharger le fichier ::PyF. {` Un iCode `}
```
## Output HTML
```
<body>
<div id="site_container">
<!--# include virtual="/template/header.html"-->
<!--# include virtual="/template/navbar.html"-->
<main id="article_sidebar"> <!-- Contains <article> and <aside> -->
<article id="article">
<time datetime="2024-01-01 16:12:44">
<header id="article_header">
<h1 id="article_title">
<a id="article_title_link" href="https://tyto.echolib.re/test.html" title="Tests -- echolib, 28/02/2023">Tests</a>
</h1>
<div id="article_refs">
echolib, 28/02/2023 [<a id="post_code" class="tyto" href="./test.tyto" title="Code source : Tests">Code source</a>]
</div>
</header>
<h2 class="toc_title">Table des matières</h2>
<nav class="toc" aria-labelledby="navigation-0">
<ul class="toc_items">
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_1">Titre 1</a></li>
<ul>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_2">Citation</a></li>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_3">Code (bloc)</a></li>
<li class="toc_item"><a class="toc_item_link tyto" href="#toc_4">Une liste</a></li>
</ul>
</ul>
</nav>
<h2 id="toc_1" class="tyto">Titre 1</h2>
<p class="tyto">
Un peu de <abbr class="tyto" title="Cascading SteelSheet" lang="en">CSS</abbr> et <a class="tyto" href="https://forge.a-lec.org" title="La forge libre">le site est prêt</a>
<p class="note">
Cet article est un test
</p>
</p>
<h3 id="toc_2" class="tyto">Citation</h3>
<blockquote class="tyto" cite="https://..." lang="fr" title="-- Auteur, Nom du livre, AAAA-MM-JJ"><time datetime="AAAA-MM-JJ">
<p class="tyto">
Citation complète dans un paragraphe
</p>
</time><footer class="tyto"><a class="tyto" href="https://...">-- Auteur, Nom du livre, AAAA-MM-JJ</a></footer></blockquote>
<h3 id="toc_3" class="tyto">Code (bloc)</h3>
<pre class="bcode_pre">
<ol class="bcode_items">
<li class="bcode_item"><code class="bcode_code"># Écrire les marqueurs de mots</code></li>
<li class="bcode_item"><code class="bcode_code"># Chaque marqueur à la classe CSS de la configuration</code></li>
<li class="bcode_item"><code class="bcode_code"># Astuce : ** + ← + `` + ← + très gras</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
<li class="bcode_item"><code class="bcode_code">*`très gras`* =&gt; &lt;strong&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">+`gras`+ =&gt; &lt;b&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">/`italique`/ =&gt; &lt;em&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">;`italique`; =&gt; &lt;i&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">_`souligné`_ =&gt; &lt;u&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">~`effacé`~ =&gt; &lt;del&gt;</code></li>
<li class="bcode_item"><code class="bcode_code">[`cité`] =&gt; &lt;q&gt; # Contenu</code></li>
<li class="bcode_item"><code class="bcode_code">:`cité`: =&gt; &lt;cite&gt; # auteur, nom</code></li>
<li class="bcode_item"><code class="bcode_code">|`perso`| =&gt; &lt;span&gt;</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
<li class="bcode_item"><code class="bcode_code"># Code dans un texte</code></li>
<li class="bcode_item"><code class="bcode_code"># ! Les marqueurs d&apos;ouverture et de fermeture de code sont sur la MEME LIGNE</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
<li class="bcode_item"><code class="bcode_code">{` &lt;li&gt;Une entrée de liste&lt;/li&gt; `} =&gt; &lt;code&gt;</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
<li class="bcode_item"><code class="bcode_code"># ! Dans certains cas, il faut ajouter un espace après le 1er marqueur</code></li>
<li class="bcode_item"><code class="bcode_code"># et/ou avant le second. Ils seront automatiquement supprimés</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
<li class="bcode_item"><code class="bcode_code">*`DOMAIN/articles/ `* # évite /` : marqueur italique ouvert</code></li>
</ol><pre>
<h3 id="toc_4" class="tyto">Une liste</h3>
<ul class="tyto">
<li class="tyto">Première entrée non ordonnée (ul)</li>
<ul>
<li class="tyto">Sous entrée non ordonnée</li>
<ol>
<li class="tyto">Première sous-sous entrée ordonnée (ol)</li>
<li class="tyto">Seconde sous-sous entrée ordonnée</li>
</ol>
</ul>
<li class="tyto">Seconde entrée non ordonnée</li>
<li class="tyto">Troisième entrée ... ... non ordonnée</li>
</ul>
<!-- Test d'ajout de code depuis un fichier -->
<pre class="bcode_pre">
<ol class="bcode_items">
<li class="bcode_item"><code class="bcode_code">#</code></li>
<li class="bcode_item"><code class="bcode_code"># Code 1</code></li>
<li class="bcode_item"><code class="bcode_code">#</code></li>
<li class="bcode_item"><code class="bcode_code"></code></li>
</ol>
</pre>
Télécharger le fichier <a class="tyto file" href="/files/code1.py" title="Lien vers un fichier">PyF</a>. <code class="tyto">Un iCode</code>
</time>
</article>
<!--# include virtual="/template/sidebar.html"-->
</main>
<!--# include virtual="/template/footer.html"-->
</div> <!-- #site_container -->
</body>
```
Reference in New Issue View Git Blame Copy Permalink