magi deprecated

mages

Le moyen le plus simple de créer un site Web pour votre projet OSS.

Installer

 fil global ajouter magi# ou npm npm i -g magi

Usage

Étant donné README.md :

 # nom du site> description du site## titre de la section> description de la section contenu du corps de la section, **ça n'a pas l'air mal, hein**.

Exécutez magi dans votre terminal, ouvrez le navigateur et vous verrez :

Comment ça marche ?

# h1 est utilisé comme nom de site, blockquote suivants seront utilisés comme description du site et tous les autres éléments entre h1 et h2 seront placés dans la bannière.

En voici un autre utilisant developit/unfetch comme exemple :

Recettes

Ajouter un ruban de coin GitHub

Vous pouvez utiliser html-matter pour le définir n'importe où dans votre fichier markdown, par exemple, en haut de celui-ci :

 <!-- @magigithub : propriétaire/dépôt-->

Notez qu'il doit commencer par @magi pour que nous sachions que nous devons l'analyser, le reste est une simple syntaxe de premier plan utilisée dans Jekyll.

Styles et scripts externes

Pour insérer une balise style et script avec une ressource externe :

 <!-- @magistyles : - ./css/custom.cssscripts : - ./js/app.js - ./js/post.js-->

CLI

 # par défaut, README.md# exécuter le serveur pour prévisualisermagi [fichier]# build html filemagi build [file]# par défaut pour afficher index.html# mais vous pouvez le modifiermagi build [file] --out docs/index.html

Contribuer

1. Fourchette-le !

2. Créez votre branche de fonctionnalités : git checkout -b my-new-feature

3. Validez vos modifications : git commit -am 'Add some feature'

4. Push vers la branche : git push origin my-new-feature

5. Soumettre une pull request :D

Auteur

magi © égoïste, publié sous licence MIT.
Rédigé et maintenu par un égoïste avec l'aide de contributeurs (liste).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin