diff --git a/README.md b/README.md index fbab18b9ed5bbde54d49641f606ba81ad9984aba..45636448eb4464ec42c6217c4dd7bec8bc9eb40b 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,39 @@ - + + ---- - -Example [Hugo] website using GitLab Pages. - -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation https://docs.gitlab.com/ce/user/project/pages/. - ---- - -<!-- START doctoc generated TOC please keep comment here to allow auto update --> -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [GitLab CI](#gitlab-ci) -- [Building locally](#building-locally) -- [GitLab User or Group Pages](#gitlab-user-or-group-pages) -- [Did you fork this project?](#did-you-fork-this-project) -- [Troubleshooting](#troubleshooting) - -<!-- END doctoc generated TOC please keep comment here to allow auto update --> - -## GitLab CI -This project's static Pages are built by [GitLab CI][ci], following the steps -defined in [`.gitlab-ci.yml`](.gitlab-ci.yml). +Ceci est un exemple de site web construit grâce à [Hugo](https://gohugo.io) et à [GitLab Pages](https://about.gitlab.com/features/pages/). -## Building locally +L'adresse du site web construit est la suivante : https://misha.gitpages.huma-num.fr/demo/hugo/ . -To work locally with this project, you'll have to follow the steps below: +La documentation officielle d'Hugo se trouve [à cette adresse](https://gohugo.io/documentation/). +Vous pouvez en apprendre davantage sur les GitLab Pages [sur cette page](https://pages.gitlab.io) ; la documentation officielle se trouve [à cette adresse](https://docs.gitlab.com/ce/user/project/pages/). -1. Fork, clone or download this project -1. [Install][] Hugo -1. Preview your project: `hugo server` -1. Add content -1. Generate the website: `hugo` (optional) - -Read more at Hugo's [documentation][]. - -### Preview your site - -If you clone or download this project to your local computer and run `hugo server`, -your site can be accessed under `localhost:1313/hugo/`. - -The theme used is adapted from http://themes.gohugo.io/beautifulhugo/. - -## GitLab User or Group Pages +--- -To use this project as your user/group website, you will need one additional -step: just rename your project to `namespace.gitlab.io`, where `namespace` is -your `username` or `groupname`. This can be done by navigating to your -project's **Settings**. +### Créer votre propre site -You'll need to configure your site too: change this line -in your `config.toml`, from `"https://pages.gitlab.io/hugo/"` to `baseurl = "https://namespace.gitlab.io"`. -Proceed equally if you are using a [custom domain][post]: `baseurl = "http(s)://example.com"`. +Pour créer très simplement votre propre site web, suivez les étapes suivantes : -Read more about [user/group Pages][userpages] and [project Pages][projpages]. +1. Forkez ce dépôt en un nouveau dépôt vous appartenant. +2. **Ne lisez pas la suite de ce texte ici !** Allez la lire sur votre dépôt à vous. +3. Modifiez la première ligne du fichier `config.yaml`. + Changez l'adresse web qui s'y trouve (originellement "https://misha.gitpages.huma-num.fr/demo/hugo/") et remplacez-là par celle indiquée sur [cette page](../../../pages). +4. C'est tout ! Votre site est en ligne à l'adresse indiquée sur [cette page](../../../pages). -## Did you fork this project? +--- -If you forked this project for your own use, please go to your project's -**Settings** and remove the forking relationship, which won't be necessary -unless you want to contribute back to the upstream project. +### Aller plus loin -## Troubleshooting +* Chaque fichier du répertoire `content/page` correspond à une page « statique » de votre site. +* Chaque fichier du répertoire `content/post` correspond à un article de blog de votre site. +* Le fichier `content/_index.md` correspond à la page d'accueil de votre site. +* Le [fichier YAML](https://fr.wikipedia.org/wiki/YAML) `config.yaml` contient les paramètres de configuration de votre site. +* Le fichier `README.md` correspond à ce que vous êtes en train de lire. + Comme tous les fichiers se terminant par `.md`, c'est un [fichier Markdown](https://docs.framasoft.org/fr/grav/markdown.html). -1. CSS is missing! That means two things: +--- - Either that you have wrongly set up the CSS URL in your templates, or - your static generator has a configuration option that needs to be explicitly - set in order to serve static assets under a relative URL. +### Qui je suis ? -[ci]: https://about.gitlab.com/gitlab-ci/ -[hugo]: https://gohugo.io -[install]: https://gohugo.io/overview/installing/ -[documentation]: https://gohugo.io/overview/introduction/ -[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages -[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages -[post]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#custom-domains +Moi, c'est [Régis Witz](https://orcid.org/0000-0002-8064-0977). Enchanté ! ʕᵔᴥᵔʔ diff --git a/content/_index.md b/content/_index.md index 9c257631be5ccee9ee1db3c0e63c1f17ee6e78d0..4dc5b7b5303f76618c3151c27bc9964d2c193342 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,8 +1,14 @@ ## Bienvenue ! -Ce site web est construit grâce à [GitLab Pages](https://about.gitlab.com/features/pages/) -et [Hugo](https://gohugo.io) et peut être construit très rapidement. -Par vous ! -Modifiez le fichier `/content/_index.md` pour changer ce qui apparait ici. +Ce site web est construit grâce à [Hugo](https://gohugo.io) et à [GitLab Pages](https://about.gitlab.com/features/pages/). +Il peut être construit très rapidement. Par vous ! + +Comment ? + +* Le fichier `content/_index.md` correspond à la page d'accueil de votre site, c'est à dire ce que vous êtes en train de lire. + Comme tous les fichiers se terminant par `.md`, c'est un [fichier Markdown](https://docs.framasoft.org/fr/grav/markdown.html). +* Chaque fichier du répertoire `content/page` correspond à une page « statique » de votre site. +* Chaque fichier du répertoire `content/post` correspond à un article de blog de votre site. +* Le [fichier YAML](https://fr.wikipedia.org/wiki/YAML) `config.yaml` contient les paramètres de configuration de votre site. Pour plus de renseignements, rendez-vous sur ce [projet GitLab](https://gitlab.huma-num.fr/misha/demo/hugo) !