Skip to content
Extraits de code Groupes Projets
README.md 1,69 ko
Newer Older
Ce fichier est à éditer lors de la première utilisation du projet.

La documentation pour utiliser ce modèle est sur [tutoriels](https://tutoriels.forge.apps.education.fr/mkdocs-pyodide-review/){:target="_blank" }
En particulier : [tutoriels création de site](https://tutoriels.forge.apps.education.fr/mkdocs-pyodide-review/08_tuto_fork/1_fork_projet/){:target="_blank" }

En bref après avoir réalisé le "Créer une bifurcation" :

- [ ] Éditer le fichier [mkdocs.yml](mkdocs.yml)
    - [ ] Modifier la clef `site_name:`
    - [ ] Modifier la clef `site_description:`
    - [ ] Modifier la clef `copyright:`
    - [ ] Modifier l'adresse mail de contact

Lors de la première construction de votre site, l'url est automatiquement définie par la clef `site_url`, afin de pointer vers une url de la forme `https://<username>.forge.aeif.fr/<projet>/`.

- [ ] Éditer le fichier [index.md](docs/index.md)
    - [ ] Le personnaliser. Il s'agit de la page d'accueil de votre site.

Mireille COILHAC's avatar
Mireille COILHAC a validé
Pour signaler un souci sur le **modèle**, écrire à [forge-apps+guichet+modeles-projets-mkdocs-pyodide-review-99-issue-@phm.education.gouv.fr](mailto:forge-apps+guichet+modeles-projets-mkdocs-pyodide-review-99-issue-@phm.education.gouv.fr) ou ouvrir un ticket sur [tickets](https://forge.apps.education.fr/modeles-projets/mkdocs-simple-review/-/issues){:target="_blank" }



- [ ] Une fois toutes les modifications précédentes effectuées, éditer ce fichier README.md pour le personnaliser.

Vous pourrez y écrire par exemple l'adresse de rendu de votre propre site.

L'adresse originale du rendu de ce site modèle avant clonage est : 

[Modèle de projet simple](https://modeles-projets.forge.apps.education.fr/mkdocs-simple-review/)