Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

903 mise a jour documentation #939

Merged
merged 40 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
88d7a82
correction des liens des images (transformer les liens relatifs en li…
RochDLY Sep 15, 2023
4a85e89
restructuration de la documentation (voir les modifs dans le menu fr.…
RochDLY Sep 18, 2023
c8aee05
modification et ajout dans la doc pages corpus, exports, mesarticles,…
RochDLY Sep 18, 2023
552ae9d
debut de la fiche sur la syntaxe yaml
RochDLY Sep 20, 2023
bf12df2
mise à jour de la page d'index de la documentation
RochDLY Sep 21, 2023
159ef7f
quelques ajouts dans la fiche sur la syntaxe yaml
RochDLY Sep 21, 2023
db28728
ajout de quelques informations dans la fiche bibliographie.md
RochDLY Sep 21, 2023
16dacbe
ajout de la fiche sur l'éditeur monaco et modification du menu dans l…
RochDLY Sep 21, 2023
296834b
ajout des informations pour la syntaxe BibTeX
RochDLY Sep 21, 2023
071414d
ajout dans la fiche sur l'édition collaborative synchrone
RochDLY Sep 21, 2023
9f7cae8
ajout des informations sur l'API GraphQl, l'édition collaborative, le…
RochDLY Sep 22, 2023
881f88f
modification des images dans la documentation : edition collaborative…
RochDLY Sep 25, 2023
7dc62b2
premieres corrections de la doc après déploiement en preprod (editeur…
RochDLY Sep 25, 2023
4f59a24
Changement du titre de la fiche syntaxe Markdown
RochDLY Sep 25, 2023
8703b73
changement du label syntaxe markdown dans le menu fr.json de la docum…
RochDLY Sep 25, 2023
e482cdd
modification du menu de la doc-en, Langue -> Language
RochDLY Sep 25, 2023
452a491
documentation : correction des coquilles dans la page de syntaxe yaml…
RochDLY Sep 26, 2023
ee7b207
corrections dans la documentation : les premiers pas deviennent pour …
RochDLY Sep 29, 2023
e5811db
documentation : test d'ajout de la section actualités dans la doc
RochDLY Sep 29, 2023
d56dec6
documentation : ajout de la page actualités dans le menu fr
RochDLY Sep 29, 2023
3c6ef13
documentation : correction de l'erreur de syntaxe dans le fichier fr.…
RochDLY Sep 29, 2023
9f3ec7d
documentation : ajout de l'index dans les actualités
RochDLY Sep 29, 2023
65000a8
documentation : modification du json et de l'index pour la nouvelle s…
RochDLY Sep 29, 2023
81bcf0f
documentation : mise à jour du logo de la chaire
RochDLY Sep 29, 2023
3057871
ajout des plugins et modification de la config 11ty pour mettre les a…
RochDLY Sep 29, 2023
d9af19d
fix #946 et ajout des shortcodes pour les link-button et les alert-block
RochDLY Sep 30, 2023
e697470
documentation : intégration des corrections ortho typo dans about / c…
RochDLY Sep 30, 2023
ff0c506
documentation : ajout de GIFs dans la documentation fr + ajout d'un s…
RochDLY Oct 1, 2023
06e57ef
documentation : mise à jour du css pour afficher .overlay img au cent…
RochDLY Oct 2, 2023
3ee65c6
déplacement du css pour img overlay dans le web component prose-block…
RochDLY Oct 2, 2023
bd61a12
documentation : correction du fichier actualites.json
RochDLY Oct 2, 2023
7042c79
documentation : corrections des lignes vides dans le document syntaxe…
RochDLY Oct 2, 2023
8fd5432
documentation : ajout de nouvelles images (et suppression de celles q…
RochDLY Oct 2, 2023
f1ba91c
documentation : suppression des images en trop et modifications en co…
RochDLY Oct 2, 2023
9254c88
ajout du toc
RochDLY Oct 4, 2023
63e12f7
documentation: modification du fonctionnement du toc
RochDLY Oct 5, 2023
12ec861
documentation : ajout des gifs pour la fonction de comparaison + 1 un…
RochDLY Oct 5, 2023
2e927c9
documentation: mise à jour de la version anglaise de la doc
RochDLY Oct 5, 2023
90b83fa
documentation : corrections du contenu fr de la doc
RochDLY Oct 5, 2023
f35a025
documentation : mise à jour de l'index fr/en et correction coquille b…
RochDLY Oct 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions docs/.eleventy.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,38 @@

const pluginWebc = require("@11ty/eleventy-plugin-webc");
const searchFilter = require("./src/filters/search");
const pluginTOC = require('eleventy-plugin-toc');
const markdownIt = require('markdown-it');
const markdownItAnchor = require('markdown-it-anchor');

// des options pour le rendu avec markdown-it
const mdOptions = {
html: true,
breaks: false,
linkify: true,
typographer: true
}

// constante pour les ancres dans les titres
const mdAnchorOpts = {
permalink: true,
permalinkClass: 'anchor-link',
permalinkSymbol: '#',
level: [1, 2, 3, 4]
};

module.exports = function(eleventyConfig) {

//Markdown : ajout des ancres sur les titres et la classe 'anchor-link'
eleventyConfig.setLibrary(
'md',
markdownIt(mdOptions)
.use(markdownItAnchor, mdAnchorOpts)
)
Comment on lines +8 to +35
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Petite remarque sur l’étendue (scope-creep) de cette PR : cette mise à jour de la documentation ratisse très large au point qu’une révision devient difficile (la révision du contenu modifié partout) et multifacette (contenu ainsi que structure de programmation).

Ici, l'ajout de paquets modifie potentiellement le rendu du contenu HTML et ajoute des dépendances supplémentaires (à considérer avec soin).

Je recommanderais de différer l'ajout d'éléments structurels de changements au contenu de la documentation (autrement dit: modifications markdown d'une part; modifications 11ty d'autre part).

L'ajout de # (ancres aux en-têtes) induit des considérations visuelles (design visuel plus chargé et à ajuster).
Cela pourrait facilement faire l'objet d'une PR séparée.


//Plugins
eleventyConfig.addFilter("search", searchFilter);
eleventyConfig.addPlugin(pluginTOC);

eleventyConfig.addPlugin(pluginWebc, {
// WebC Components
Expand Down Expand Up @@ -42,6 +70,46 @@ module.exports = function(eleventyConfig) {
// Nous pourrions ajouter d’autres collections
// ex. pour les annonces, ou sous /blog


// Les shortcodes vont ici
// shortcode sert pour créer le composant bouton
eleventyConfig.addPairedShortcode("link-button", function (content, href, color, size) {
if (size != undefined) {
size = size;
} else {
size = "small";
}
return `
<link-button href="${href}" color="${color}" size="${size}">${content}</link-button>`;
});


// shortcode pour les alert-block
eleventyConfig.addPairedShortcode("alert-block", function (content, heading, type) {
if (type != undefined) {
type = type;
} else {
type = "neutral";
}
return `
<alert-block type="${type}" heading="${heading}">${content}</alert-block>`
});

// shortcode pour rendre l'image cliquable
eleventyConfig.addShortcode("figure", function (src, caption, alt) {
let figcaption_html = (caption != "") ? `<figcaption>${caption}</figcaption>` : '';
return `
<figure>
<a href="#${src}" id="_${src}">
<img lazy="true" src="${src}" alt="${alt ? alt : (caption ? caption : '')}" />
</a>
<a href="#_${src}" class="overlay" id="${src}">
<img src="${src}" alt="${alt ? alt : (caption ? caption : '')}" />
</a>
${figcaption_html}
</figure>`;
});

// Copier les contenus du dossier `uploads/` tels quels
// (sans le dossier `uploads/` dans le chemin de destination)
eleventyConfig.addPassthroughCopy("uploads");
Expand Down
Loading