diff --git a/README-FR.md b/README-FR.md new file mode 100644 index 0000000000000000000000000000000000000000..8093b18e2a8fc3bfc10da9134b5ad083fbf842b6 --- /dev/null +++ b/README-FR.md @@ -0,0 +1,73 @@ +# slidev-theme-alpaga + +[🇬🇧 English version](README.md) + +Alpaga est un thème pour [Slidev](https://github.com/slidevjs/slidev) simple et rapide à mettre en place. Étant pensé pour l'export PDF et pour être facilement adapté à n'importe quelle identité graphique, Alpaga est idéal pour styliser tes prises de notes MarkDown, brochures et antisèches ! + +[](https://www.npmjs.com/package/@lydra/slidev-theme-alpaga) + +Alpaga theme pour [Slidev](https://github.com/slidevjs/slidev). + +## Installation + +Il suffit d'ajouter le frontmatter suivant en tête de ton fichier `slides.md`. Lance Slidev et tu seras invité à télécharger le thème. + +<pre><code>--- +theme: <b>alpaga</b> +---</code></pre> + +En savoir plus sur [comment s'utilisent les thèmes](https://fr.sli.dev/themes/use.html). + + +## Personnalisation + +### Thème et couleurs + +Le mode clair/sombre et la palette sont personnalisables dans le frontmatter avec 'colorSchema' et 'themeConfig' respectivement. + +``` +colorSchema: 'dark' +themeConfig: + primary: '#00FF7F' + secondary: '#66CDAA' + code: 'black' +``` +Tu peux changer la couleur du code indépendament du mode sombre/clair pour qu'elle soit toujours adaptée à la couleur secondaire qui apparaitra derrière. + +### Configurer l'overlay + +La configuration de l'overlay se fait dans le frontmatter également. +``` +themeConfig: + subtitle: "Slidev Alpaga Theme" + logoSrc: "/img/dummy-logo.png" + licenseImg: "/img/license.png" + author: "Celeste" + version: "0.1" +``` + +### Polices + +Les polices sont elles aussi à configurer dans le frontmatter de tes slides, elle seront importées automatiquement depuis [Google Fonts](https://fonts.google.com/), il te suffit de renseigner leurs noms. + +``` +fonts: + sans: 'Montserrat' + serif: 'Comfortaa' + mono: 'Fira Code' +``` + +Si tu préfères utiliser des polices locales, regarde [cette doc](https://fr.sli.dev/custom/fonts.html#polices-locales). + +## Contribution + +- `npm install` +- `npm run dev` pour lancer l'apercu de `example.md` +- Modifie `example.md` pour voir apparaitre les modifications +- `npm run export` pour générer un PDF +- `npm run screenshot` pour générer une aperçu PNG + + +## Licence + +[](https://choosealicense.com/licenses/gpl-3.0/) diff --git a/README.md b/README.md index f827c1422088cfb4e72dc98b19043d0525011518..2fd2912cda48f5339585ba7bdaba7666f2634e61 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # slidev-theme-alpaga +[🇫🇷 French version](README-FR.md) + Alpaga is a simple and quick to set up theme for [Slidev](https://github.com/slidevjs/slidev). It's ideal for Markdown notes, booklets or cheatsheets as you can easily customize it to your business colors and identity and export to PDF. -[](https://www.npmjs.com/package/slidev-theme-slidev-theme) +[](https://www.npmjs.com/package/@lydra/slidev-theme-alpaga) Alpaga theme for [Slidev](https://github.com/slidevjs/slidev). @@ -16,6 +18,7 @@ theme: <b>alpaga</b> Learn more about [how to use a theme](https://sli.dev/themes/use). + ## Customization ### Theme and colors