kazhnuz/moineau
1
0
Fork 0
Code Issues 7 Pull requests Releases 2 Wiki Activity

feat: nouvelle génération de site

Browse source
This commit is contained in:
Kazhnuz 2024-09-23 10:14:52 +02:00
parent 726e855315
commit a5f0de5ae0
5 changed files with 124 additions and 149 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,4 +1,30 @@
clear-typography
================
# clear-typography
Un projet CSS permettant d'avoir une typo plutot propre pour un blog/site, basé sur la police clear-sans, et pensé pour être utilisé en premier lieu avec bootstrap.
**Clear-Typography** est un projet de feuille de style minimale inspirée des sites [bettermotherfuckingwebsite](http://bettermotherfuckingwebsite.com/) et [thebestmotherfucking.website](https://thebestmotherfucking.website/). Son but est d'être utilisé en remplacement du style par défaut de navigateur web pour des pages web "brutes", tout en restant agréable et fonctionnel.
Son but est d'avoir un style agréable à l'oeil et fonctionnel, assez minimaliste, utilisant les balises et propriété de l'HTML brut. Il n'y a pas de classe utilisé, ni de fonctionnalité de layout (à l'exception d'un support des navbar via `<nav>` qui donne des navbar horizontales).
Si le projet utilise surtout les balises standard du HTML, quelques utilitaires vont être ajoutés.
## Fonctionnalités
Clear-typography supporte les fonctionnalités suivantes de base :
- Feuille de style simple et légère (TBD ko)
- Responsive (en tout cas le plus possible)
- Concentré sur la typographie et n'utilisant pas de classes
- Gestion des couleurs
- Support du mode sombre
- Customisation des couleurs via des variables
## Pourquoi
Tout les sites n'ont pas besoins de design spécifique, et le but de cette feuille de style est de fournir une feuille de style simple et customisable pour des sites "tout bêtes". Il a notamment été *optimisé* pour un cas spécifique : la génération de page web à partir de page markdown, mais supporte quelques cas en plus (notamment les balises standards du HTML).
L'idée est que dans le cas de ce genre de site peuvent avoir besoin de style simple et léger, s'adapter à de différents écrans et surtout lisible : pas de lignes trop longues, et avec un texte aéré (interligne, fin de paragraphes). Le but est d'avoir un côté un peu moderne aussi, avec quelques touches de couleurs.
L'idée est de pouvoir générer simplement un blog ou un site simple pour les gens en ayant besoin. Je ne pense pas que ce sera beaucoup utilisé, mais cela peut servir dans quelques cas spécifiques ^^
## Crédits
- Les couleurs proviennent de [open-color](https://yeun.github.io/open-color/)

38
exemples/exemples.md Normal file
View file

@ -0,0 +1,38 @@
# Exemples
Quelques exemples des styles que prennent différents composants
## Details
La balise `<details>` permet de cacher et afficher une information au clic. Ici, elle a été stylisé comme un bloc, et le sommaire a reçu un état au survol pour que ce soit plus visible que c'est un élément interactif
<details>
<summary>Sommaire</summary>
Contenu du `details`.
</details>
## Mark
La balise `<mark>` permet d'afficher simplement des éléments en <mark>surbrillance</mark>. Cela utilise la couleur d'accent claire (et sombre en mode sombre). Le style est proche de celui de code, mais sans monospace et avec la couleur d'accent.
## Artictecture des titres
Les différents types ont différent style, et voici ce que ça donne du h3 au h6 (le h1 est le titre de page, et le h2 celui juste au dessus)
### Titre H3
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae augue ut enim iaculis consequat.
#### Titre H4
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae augue ut enim iaculis consequat.
##### Titre H5
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae augue ut enim iaculis consequat.
###### Titre H6
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae augue ut enim iaculis consequat.

49
generate.js Normal file
View file

@ -0,0 +1,49 @@
var marked = require('marked')
var fs = require('fs')
const inFile = "README.md"
const outFile = "dist/index.html"
function parse(inFile, outFile) {
const inputContent = fs.readFileSync(inFile, 'utf8')
const content = `<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Clear-Typography.css</title>
<link href="css/clear-typography.min.css" rel="stylesheet">
<link
rel="icon"
href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><text y='.9em' font-size='90'>🐤</text></svg>"
/>
</head>
<body>
<header>
<nav>
<ul>
<li><a href="/">Accueil</a></li>
<li><a href="/exemples.html">Exemples</a></li>
<li><a href="https://git.kobold.cafe/kazhnuz/clear-typography">Sources</a></li>
</ul>
</nav>
</header>
<main>
<article>
${marked.parse(inputContent)}
</article>
</main>
<hr>
<footer class="flex">
<div><small>Clear-Typography</small></div>
<div><small>CC BY <a href="https://kazhnuz.space/">Kazhnuz</a></small></div>
</footer>
</body>
</html>`
fs.writeFileSync(outFile, content)
}
parse("README.md", "dist/index.html")
parse("exemples/exemples.md", "dist/exemples.html")

140
index.html
View file

@ -1,140 +0,0 @@
<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="utf-8">
<title>Ma Page de tête</title>
<!-- meta -->
<meta name="description" content="">
<meta name="author" content="">
<!-- mon icon -->
<link rel="shortcut icon" href="favicon.ico">
<!-- framework utilisés -->
<link href="dist/clear-typography.min.css" rel="stylesheet">
</head>
<body>
<h1>
Document de Test
</h1>
<time class="time"> Le vendredi 19 septembre 2014 à 07:16 </time>
<h2>
Introduction : Lorem Ipsum
</h2>
<p>
<em>
Lorem ipsum dolor sit amet
<sup>
<a href="#1">
[1]
</a>
</sup>
, consectetur adipiscing elit. Praesent varius ullamcorper diam, non sagittis lectus rutrum id. Integer eros urna, egestas et libero a, finibus egestas odio. Nunc vel hendrerit quam, eget malesuada sem. Sed hendrerit ligula pharetra leo aliquam volutpat. Integer auctor urna ac convallis laoreet. Nunc vestibulum ipsum sed tortor aliquam porta. Cras nunc est, lobortis in est at, rhoncus auctor nunc. Sed dignissim erat non sollicitudin ultricies. Integer vel consectetur urna. Etiam fermentum ligula vitae nunc viverra, a fringilla sem aliquam. Suspendisse potenti. Morbi sem mi, malesuada quis odio vitae, suscipit congue metus. Sed ut ullamcorper urna, eget molestie est. Sed pulvinar justo ac urna consectetur fringilla. Donec tristique eget leo sit amet mollis.
</em>
</p>
<ul>
<li>
1 - Filmographie de Joachim du Poulet
<ul>
<li>
1.1 - Pour une poignée de Poulet
</li>
<li>
1.2 - Pour quelques Poulet de plus
<ul>
<li>
Le personnage du Coq au Vin
<ul>
<li>
En plus il est délicieux
</li>
</ul>
</li>
</ul>
</li>
<li>
1.3 - Le bon, la brute et le Poulet
</li>
</ul>
</li>
<li>
2 - Les Cocotes : Etude de leur Violence
</li>
</ul>
<h3>
Filmographie de Joachim du Poulet
</h3>
<p>
Nous allons commencer par une célèbre citation de ce non moins célèbre réalisateur, en latin parce que c'est plus classe :
</p>
<blockquote>
<p>
Cras malesuada, metus at viverra molestie, mi ligula sodales tellus, vitae facilisis ante est vitae dolor. Donec feugiat non est eget elementum. Nullam in erat et arcu tincidunt maximus. Nullam nibh orci, egestas eu ex non, viverra pretium magna. Proin convallis, risus eu condimentum luctus, ante dui mattis eros, a varius risus diam sed nisl. Ut malesuada ipsum in augue accumsan ullamcorper. Phasellus efficitur augue in venenatis sollicitudin. Integer at consectetur arcu.
</p>
</blockquote>
<h4>
Pour une poignée de poulets
</h4>
<p>
Proin bibendum felis sit amet nisl iaculis,
<strong>
vel blandit purus dictum
</strong>
. Maecenas ullamcorper tortor ac dolor pulvinar, id imperdiet arcu suscipit.
<mark>
Sed posuere lectus eu orci tristique maximus
</mark>
. Nulla facilisi. Aenean sed fermentum nisl. Donec sodales ligula eu est finibus, eu posuere ligula condimentum. Morbi arcu magna, varius id justo ac, aliquam luctus magna. Pellentesque a velit et ipsum euismod congue eget eu sem. Nulla luctus est nec arcu volutpat blandit.
</p>
<p>
Quisque egestas, elit eu tempus tincidunt, mi libero porta purus, eget lobortis metus erat a dolor. Integer ac turpis lacinia, interdum nisl non, feugiat libero. Sed auctor quam turpis, quis volutpat lectus consectetur at.
<del>
Vestibulum tristique tellus eu nibh feugiat malesuada eu vitae diam.
</del>
Aenean mi leo, suscipit nec euismod vel, suscipit eu elit. Duis pharetra lectus risus, eget gravida felis mattis ac. Sed vitae arcu purus.
</p>
<h4>
Pour quelques poulets de plus
</h4>
<h5>
Le personnage du Coq au Vin
</h5>
<p>
Integer enim diam, venenatis sit amet ex ut, tincidunt ullamcorper erat. Cras sodales nibh quis nunc sodales, a pulvinar lacus eleifend. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Ut feugiat quam scelerisque, tempus ex et, volutpat ante. Pellentesque facilisis sapien non odio tempus, eget ultricies augue porttitor. Donec elementum tincidunt eros et accumsan. Nam nec lacinia est. Quisque erat mauris, sagittis nec nulla ac, convallis tempus nulla. Phasellus ligula nisl, vulputate id dapibus in, efficitur ut sapien. Suspendisse dapibus diam sit amet egestas pellentesque. Nulla vel eleifend dui. Morbi nec interdum sem. Nullam fringilla tincidunt viverra. Integer sodales elementum quam, id malesuada magna vulputate ut.
</p>
<h6>
En plus il est délicieux
</h6>
<p>
Proin rhoncus metus rhoncus, aliquam tellus et, interdum odio. Morbi porttitor commodo ullamcorper. Sed iaculis orci id nunc porta tristique. Morbi auctor neque vitae suscipit pellentesque. Maecenas id lacinia leo, nec dictum leo. Aliquam cursus semper quam, vel bibendum tellus commodo sit amet. Vestibulum et iaculis justo, nec tempor nibh. Integer eu felis neque.
</p>
<h4>
Le Bon, la Brute et le Poulet
</h4>
<p>
Nullam iaculis viverra tristique. Proin nibh eros, eleifend euismod quam sit amet, auctor scelerisque libero. Suspendisse consequat porttitor leo id feugiat. Suspendisse pretium, erat nec vulputate scelerisque, lectus libero ultrices arcu, sed sagittis magna lectus vitae purus. Aliquam pharetra tincidunt nibh nec rutrum. Maecenas fringilla ultrices suscipit. Praesent mattis risus non orci vestibulum, vulputate dapibus velit mollis. Quisque sagittis odio velit, vel dapibus turpis commodo nec. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Integer sit amet posuere ligula. Vestibulum commodo nulla eget nibh luctus, a interdum leo lacinia. Nullam mattis aliquet mauris sed tincidunt. Mauris et velit elementum, facilisis turpis in, viverra orci. Aenean ac lorem ullamcorper, bibendum ipsum sit amet, volutpat magna. Nam pellentesque venenatis ligula sed sagittis. Maecenas porttitor blandit magna sed posuere.
</p>
<h3>
Les Cocotes : Etude de leur Violence
</h3>
<p>
Mauris a cursus sem, in tempus odio. Curabitur ut ullamcorper enim. In faucibus odio ac arcu pharetra, ac condimentum ex ultricies. Aenean vestibulum eu lacus ac luctus. In in metus libero. Aliquam erat volutpat. Suspendisse quis ultrices odio. Nulla maximus faucibus lobortis.
</p>
<pre><code>Vivamus tincidunt dolor quis consectetur dapibus.
Ut metus risus, lobortis non venenatis in, ultricies a orci.
In suscipit ante et aliquet pretium.
Integer diam dui, rutrum vitae risus ultricies, varius vulputate magna.
In id suscipit elit.
</code></pre>
<hr/>
<p>
[1] : Sed et odio volutpat, convallis est et, interdum sapien.
</p>
</body>
</html>

14
package.json
View file

@ -4,12 +4,13 @@
"description": "A minimal and simple css stylesheet, inspired by motherfuckingwebsite",
"main": "scss/clear-typography.scss",
"scripts": {
"scss": "sass --watch scss/clear-typography.scss dist/clear-typography.css",
"scss-no-source-map": "sass --watch --no-source-map scss/clear-typography.scss dist/clear-typography.css",
"minify": "sass --watch scss/clear-typography.scss --style compressed dist/clear-typography.min.css",
"minify-no-source-map": "sass --watch --no-source-map scss/clear-typography.scss --style compressed dist/clear-typography.min.css",
"build": "sass scss/clear-typography.scss dist/clear-typography.css && sass scss/clear-typography.scss --style compressed dist/clear-typography.min.css",
"serve": "http-server ./ & npm run minify"
"scss": "sass --watch scss/clear-typography.scss dist/css/clear-typography.css",
"scss-no-source-map": "sass --watch --no-source-map scss/clear-typography.scss dist/css/clear-typography.css",
"minify": "sass --watch scss/clear-typography.scss --style compressed dist/css/clear-typography.min.css",
"minify-no-source-map": "sass --watch --no-source-map scss/clear-typography.scss --style compressed dist/css/clear-typography.min.css",
"build": "sass scss/clear-typography.scss dist/css/clear-typography.css && sass scss/clear-typography.scss --style compressed dist/css/clear-typography.min.css",
"serve": "http-server ./dist & npm run site & npm run minify",
"site": "node generate.js"
},
"repository": {
"type": "git",
@ -23,6 +24,7 @@
"license": "GPL-3.0-or-later",
"dependencies": {
"http-server": "^14.1.1",
"marked": "^14.1.2",
"sass": "^1.78.0"
}
}