présentation

Shrimple est un alternative au Markdown, conçu pour être plus simple et plus lisible. Il permet de créer des documents qui sont à la fois lisibles en tant que texte brut et en HTML.

fonctionnement

Pour utiliser Shrimple, il faut d'abord compiler le code source avec un compilateur Go. Ensuite, on peut l'exécuter avec des options telles que -s pour ajouter une feuille de style par défaut et -w pour entourer la page d'un HTML complet.

cat README | ./shrimple -s -w > README.html

Les liens sont créés de manière à être propres et lisibles, en utilisant des notes de bas de page pour stocker les URL. Les blocs de code doivent être indentés avec 6 espaces et peuvent contenir des sauts de ligne.

analyse technique

Shrimple prend en charge les listes numérotées et à puces, ainsi que les en-têtes de niveau 1 et 2. Les notes peuvent être créées avec un mot en majuscules suivi de deux points et des lignes indentées avec 4 espaces.

Une des fonctionnalités les plus puissantes de Shrimple est la possibilité de parser et de rendre des dictionnaires. Cela permet de mettre en évidence des mots ou des expressions spécifiques dans le texte sans avoir à ajouter de balises HTML.

génération de site statique

Shrimple peut également générer des sites statiques à partir de fichiers sources. Il prend en charge la création de menus et de liens de navigation pour les pages générées.

Pour générer un site statique, il faut utiliser l'option -g suivie du chemin du répertoire source et du répertoire de sortie. Les options -n et -m permettent d'ajouter des liens de navigation et un menu respectivement.

./shrimple -s -g -n -m examples/StaticSite StaticSite_out