Skip to content

Commit

Permalink
+ doc publication github page
Browse files Browse the repository at this point in the history
  • Loading branch information
gllmAR committed Sep 4, 2024
1 parent aa952c2 commit 0412084
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 8 deletions.
4 changes: 3 additions & 1 deletion activites/2_corpus_multimedia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Livrable: URL du document en ligne
* Fonctionnement : Expliquez comment cette composante centrale opère dans l'œuvre. Comment contribue-t-elle à l'expérience globale ? Quel rôle joue-t-elle dans l'engagement du public ou dans l'atteinte des objectifs de l'œuvre ?
* Impact : Discutez de l'impact de cette composante sur la réception de l'œuvre. En quoi cet élément distingue-t-il l'œuvre dans le paysage multimédia ?

#### Appréciation personnelle
#### Appréciation et commentaire personnel

( Pourquoi avoir choisi cette oeuvre)

Expand All @@ -63,7 +63,9 @@ Livrable: URL du document en ligne
* [Docsify](/contenus/docsify/)
* [vscode.dev](/contenus/vscodeDev/)

## Modèle de page Docsify à personaliser

*

## Évaluations associées

Expand Down
35 changes: 35 additions & 0 deletions contenus/docsify/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# Docsify


[Docsify](https://docsify.js.org/#/) est un générateur de documentation en temps réel qui permet de créer des sites de documentation à partir de fichiers Markdown, sans avoir besoin de générer des fichiers HTML statiques à l'avance. Il est particulièrement utile pour des projets open-source, des manuels techniques, et des guides utilisateurs. Docsify se distingue par sa simplicité et sa capacité à fonctionner directement depuis le navigateur sans compilation préalable.

## Caractéristiques principales

### Documentation basée sur Markdown :

Docsify utilise des fichiers Markdown (fichiers .md) pour structurer et écrire le contenu de la documentation. Cela permet aux utilisateurs de se concentrer sur l’écriture du contenu sans se soucier de la structure HTML.

### Pas de génération statique :

Contrairement à d'autres générateurs de sites statiques comme Jekyll ou Hugo, Docsify ne nécessite pas de précompilation des fichiers. Vous ajoutez simplement vos fichiers Markdown, et Docsify se charge du rendu directement dans le navigateur.

### Facilité d'installation :

Docsify peut être installé localement via npm (Node Package Manager), ou bien utilisé via un simple CDN sans aucune installation locale.
Par exemple, avec une inclusion CDN, il suffit de créer un fichier index.html avec un lien vers la bibliothèque Docsify pour démarrer.

### Personnalisation flexible :

Vous pouvez personnaliser le thème de Docsify, ajouter des barres latérales (sidebars), un menu de navigation, des ancres pour les titres, et plus encore.
Il permet aussi d'ajouter des plugins ou des extensions pour des fonctionnalités supplémentaires comme la génération de PDF, l'intégration de vidéos, ou des fonctionnalités interactives.


### Support de recherche :

Docsify intègre une fonctionnalité de recherche rapide qui indexe les titres et sous-titres des documents, facilitant ainsi la navigation.

### Support pour les Pages GitHub :

Docsify fonctionne très bien avec Pages GitHub, permettant d’héberger la documentation directement sur GitHub. Il est ainsi facile de maintenir la documentation en lien avec un projet et de la rendre accessible à tous via une URL publique.

### Awesome Docsify

* [https://docsify.js.org/#/awesome](https://docsify.js.org/#/awesome)
5 changes: 5 additions & 0 deletions contenus/github/pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,10 @@ Committer l'action suggérée

Une fois les changements appliqués, GitHub générera une URL pour votre site (par exemple, https://username.github.io/repository-name), qui sera automatiquement mis à jour chaque fois que vous pousserez des modifications au dépôt.

### Afficher un lien vers la page

![Params Page](repo-parametre.png)


![Lien vers la page](page-deploiement-lien-dans-repository.png)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contenus/github/pages/repo-parametre.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion contenus/markdown/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Markdown

Language de balisage léger visant à être lisible par des humains
Language de balisage léger visant à être lisible par des humains.

Le `Markdown` est un langage de balisage simple permettant de formater du texte et d'intégrer des éléments multimédia (images, vidéos, liens). Utilisé par les intégrateurs multimédia, il permet de structurer du contenu avec des balises fondamentales comme `#` pour les titres, `*` pour les listes, `![]()` pour les images, et `[texte](lien)` pour les hyperliens. Il est idéal pour la création rapide de documents ou de pages web.

## Standardisation

Expand Down
13 changes: 7 additions & 6 deletions cours/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@

### Contenus

* Conception d’un projet multimédia
* Collaboration à l’échange d’idées
* Proposition artistique originale et recherchée
* Objectifs et structure du scénario
* Documentation de l’analyse du projet
* Éléments du design et de la navigation
* Conception d’un projet multimédia [exemple: Inflorescences](https://_inflorescence.gitlab.io/mutek2024/#/annexes/venues/)
* Proposition artistique originale et recherchée [inspiration village numérique?](/activites/1_sortie_mutek/)
* Collaboration à l’échange d’idées [via Git](/contenus/git/)
* Objectifs et structure du scénario [en Markdown](/contenus/markdown/)
* Documentation de l’analyse du projet [github page](/contenus/github/pages/)
* Éléments du design et de la navigation [Docsify](/contenus/docsify/)

### Activités

* [Corpus Multimédia](/activites/2_corpus_multimedia/README.md)
* **EF-1 :** Corpus d'œuvres multimédia


Expand Down

0 comments on commit 0412084

Please sign in to comment.