feat: Update content
This commit is contained in:
parent
5e28353ca5
commit
17701eb026
161
README.md
161
README.md
|
|
@ -1,156 +1,21 @@
|
||||||
<p align="center">
|
# Loi.re
|
||||||
<a href="https://getdoks.org/">
|
|
||||||
<img alt="Doks" src="https://doks.netlify.app/logo-doks.svg" width="60">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h1 align="center">
|
Documentation du Services Numériques Libres hébergé dans le département de la Loire (42)
|
||||||
Doks
|
|
||||||
</h1>
|
|
||||||
|
|
||||||
<h3 align="center">
|
## TODO
|
||||||
Doks Child Theme
|
|
||||||
</h3>
|
|
||||||
|
|
||||||
<p align="center">
|
- [ ] Ajouter du contenu pour le logiciel PDF
|
||||||
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
- [ ] Ajouter le déploiement automatique
|
||||||
</p>
|
|
||||||
|
|
||||||
<p align="center">
|
## Commande
|
||||||
<a href="https://github.com/h-enk/doks-child-theme/blob/master/LICENSE">
|
|
||||||
<img src="https://img.shields.io/github/license/h-enk/doks-child-theme?style=flat-square" alt="GitHub">
|
|
||||||
</a>
|
|
||||||
<a href="https://github.com/h-enk/doks-child-theme/releases">
|
|
||||||
<img src="https://img.shields.io/github/v/release/h-enk/doks-child-theme?include_prereleases&style=flat-square"alt="GitHub release (latest SemVer including pre-releases)">
|
|
||||||
</a>
|
|
||||||
<a href="https://github.com/h-enk/doks-child-theme/actions/workflows/codeql-analysis.yml">
|
|
||||||
<img src="https://img.shields.io/github/workflow/status/h-enk/doks-child-theme/CodeQL/master?style=flat-square" alt="GitHub Workflow Status (branch)">
|
|
||||||
</a>
|
|
||||||
<a href="https://app.netlify.com/sites/hyas-child-theme/deploys">
|
|
||||||
<img src="https://img.shields.io/netlify/75395a37-8537-4410-a8c3-d56bf27ec963?style=flat-square" alt="Netlify">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
Il faut avoir Node.js (dernière LTS) d'installé sur son ordinateur pour importer les dépendances et lancer la construction du site.
|
||||||
|
|
||||||
## Demo
|
- Installation des dépendances : npm install
|
||||||
|
- Lancement du site en mode développement : npm run start
|
||||||
|
- Lancement des tests : npm run test
|
||||||
|
- Construction du site : npm run build
|
||||||
|
|
||||||
- [doks-child-theme.netlify.app](https://doks-child-theme.netlify.app/)
|
## License
|
||||||
|
|
||||||
## Why Doks?
|
Documentation libre sous license GPL V3
|
||||||
|
|
||||||
Nine main reasons why you should use Doks:
|
|
||||||
|
|
||||||
1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
|
|
||||||
|
|
||||||
2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=59aafe464a68f8bc30b8e9a636d5b053) by default. Doks removes unused css, prefetches links, and lazy loads images.
|
|
||||||
|
|
||||||
3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
|
|
||||||
|
|
||||||
4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
|
|
||||||
|
|
||||||
5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.
|
|
||||||
|
|
||||||
6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
|
|
||||||
|
|
||||||
7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
|
|
||||||
|
|
||||||
8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
|
|
||||||
|
|
||||||
9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.
|
|
||||||
|
|
||||||
### Other features
|
|
||||||
|
|
||||||
- __Multilingual and i18n__ support
|
|
||||||
- __Versioning__ documentation support
|
|
||||||
- __KaTeX__ math typesetting
|
|
||||||
- __Mermaid__ diagrams and visualization
|
|
||||||
- __highlight.js__ syntax highlighting
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- [Git](https://git-scm.com/) — latest source release
|
|
||||||
- [Node.js](https://nodejs.org/) — latest LTS version or newer
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Why Node.js?</summary>
|
|
||||||
|
|
||||||
Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
## Get started
|
|
||||||
|
|
||||||
Start a new Doks project in three steps:
|
|
||||||
|
|
||||||
### 1. Create a new site
|
|
||||||
|
|
||||||
Doks is available as a child theme and a starter theme.
|
|
||||||
|
|
||||||
#### Child theme
|
|
||||||
|
|
||||||
- Intended for novice to intermediate users
|
|
||||||
- Intended for minor customizations
|
|
||||||
- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Starter theme
|
|
||||||
|
|
||||||
- Intended for intermediate to advanced users
|
|
||||||
- Intended for major customizations
|
|
||||||
- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site
|
|
||||||
```
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Help me choose</summary>
|
|
||||||
|
|
||||||
Not sure which one is for you? Pick the child theme.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### 2. Install dependencies
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Start development server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
## Other commands
|
|
||||||
|
|
||||||
Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
- [Netlify](https://docs.netlify.com/)
|
|
||||||
- [Hugo](https://gohugo.io/documentation/)
|
|
||||||
- [Doks](https://getdoks.org/)
|
|
||||||
|
|
||||||
## Communities
|
|
||||||
|
|
||||||
- [Netlify Community](https://community.netlify.com/)
|
|
||||||
- [Hugo Forums](https://discourse.gohugo.io/)
|
|
||||||
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
|
|
||||||
|
|
||||||
## Sponsors
|
|
||||||
|
|
||||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
|
|
||||||
|
|
||||||
[](https://opencollective.com/doks/tiers/sponsor/0/website)
|
|
||||||
[](https://opencollective.com/doks/tiers/sponsor/1/website)
|
|
||||||
|
|
||||||
## Backers
|
|
||||||
|
|
||||||
Support this project by becoming a backer. Your avatar will show up here.
|
|
||||||
|
|
||||||
[](https://opencollective.com/doks)
|
|
||||||
|
|
|
||||||
|
|
@ -33,15 +33,15 @@
|
||||||
url = "/documentation/introduction/bienvenue/"
|
url = "/documentation/introduction/bienvenue/"
|
||||||
weight = 10
|
weight = 10
|
||||||
|
|
||||||
[[main]]
|
#[[main]]
|
||||||
name = "Guides"
|
# name = "Guides"
|
||||||
url = "/tutorial/lorem/ipsum/"
|
# url = "/tutorial/lorem/ipsum/"
|
||||||
weight = 15
|
# weight = 15
|
||||||
|
|
||||||
[[main]]
|
#[[main]]
|
||||||
name = "Blog"
|
# name = "Blog"
|
||||||
url = "/blog/"
|
# url = "/blog/"
|
||||||
weight = 20
|
# weight = 20
|
||||||
|
|
||||||
#[[main]]
|
#[[main]]
|
||||||
# name = "Get Started"
|
# name = "Get Started"
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title : "Services Numériques Libres"
|
title : "Services Numériques Libres"
|
||||||
description: "L'ensemble des services sont hébergés dans le département de la Loire (42)"
|
description: "L'ensemble des services sont hébergés dans le département de la Loire (42)"
|
||||||
lead: "Ce site WEB vous met à disposition de multiples services utiles pour collaborer, partager et avoir une vie numérique plus « saine ».<br><br>Vous trouverez aussi des <a href=\"/blog/\">articles de blog</a> et <a href=\"/guides/\">guides</a> parlant du numérique et son utilisation de façon responsable."
|
lead: "Ce site WEB vous met à disposition de multiples services utiles pour collaborer, partager et avoir une vie numérique plus « saine »."
|
||||||
date: 2020-10-06T08:47:36+00:00
|
date: 2020-10-06T08:47:36+00:00
|
||||||
lastmod: 2020-10-06T08:47:36+00:00
|
lastmod: 2020-10-06T08:47:36+00:00
|
||||||
draft: false
|
draft: false
|
||||||
|
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
---
|
|
||||||
title: "Say hello to Doks 👋"
|
|
||||||
description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
|
||||||
excerpt: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
|
||||||
date: 2020-11-04T09:19:42+01:00
|
|
||||||
lastmod: 2020-11-04T09:19:42+01:00
|
|
||||||
draft: false
|
|
||||||
weight: 50
|
|
||||||
images: []
|
|
||||||
categories: ["News"]
|
|
||||||
tags: ["security", "performance", "SEO"]
|
|
||||||
contributors: ["Simon"]
|
|
||||||
pinned: false
|
|
||||||
homepage: false
|
|
||||||
---
|
|
||||||
|
|
||||||
Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
---
|
|
||||||
title: "Blog"
|
|
||||||
description: "Le blog de Loi.re."
|
|
||||||
date: 2020-10-06T08:49:55+00:00
|
|
||||||
lastmod: 2020-10-06T08:49:55+00:00
|
|
||||||
draft: false
|
|
||||||
images: []
|
|
||||||
---
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
---
|
|
||||||
title: "Contributors"
|
|
||||||
description: "The Doks contributors."
|
|
||||||
date: 2020-10-06T08:50:29+00:00
|
|
||||||
lastmod: 2020-10-06T08:50:29+00:00
|
|
||||||
draft: false
|
|
||||||
images: []
|
|
||||||
---
|
|
||||||
|
|
||||||
The Doks contributors.
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
---
|
|
||||||
title: "Henk Verlinde"
|
|
||||||
description: "Creator of Hyas."
|
|
||||||
date: 2020-10-06T08:50:45+00:00
|
|
||||||
lastmod: 2020-10-06T08:50:45+00:00
|
|
||||||
draft: false
|
|
||||||
images: []
|
|
||||||
---
|
|
||||||
|
|
||||||
Creator of Hyas.
|
|
||||||
|
|
||||||
[@HenkVerlinde](https://twitter.com/henkverlinde)
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
---
|
|
||||||
title : "Docs"
|
|
||||||
description: "Docs Doks."
|
|
||||||
lead: ""
|
|
||||||
date: 2020-10-06T08:48:23+00:00
|
|
||||||
lastmod: 2020-10-06T08:48:23+00:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
---
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
---
|
|
||||||
title: "Help"
|
|
||||||
description: "Help Doks."
|
|
||||||
lead: ""
|
|
||||||
date: 2020-10-06T08:49:15+00:00
|
|
||||||
lastmod: 2020-10-06T08:49:15+00:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
weight: 600
|
|
||||||
---
|
|
||||||
|
|
@ -1,50 +0,0 @@
|
||||||
---
|
|
||||||
title: "FAQ"
|
|
||||||
description: "Answers to frequently asked questions."
|
|
||||||
lead: "Answers to frequently asked questions."
|
|
||||||
date: 2020-10-06T08:49:31+00:00
|
|
||||||
lastmod: 2020-10-06T08:49:31+00:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "help"
|
|
||||||
weight: 630
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Hyas?
|
|
||||||
|
|
||||||
Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas.
|
|
||||||
|
|
||||||
## Footer notice?
|
|
||||||
|
|
||||||
Please keep it in place.
|
|
||||||
|
|
||||||
## Keyboard shortcuts for search?
|
|
||||||
|
|
||||||
- focus: `Ctrl + /`
|
|
||||||
- select: `↓` and `↑`
|
|
||||||
- open: `Enter`
|
|
||||||
- close: `Esc`
|
|
||||||
|
|
||||||
## Other documentation?
|
|
||||||
|
|
||||||
- [Netlify](https://docs.netlify.com/)
|
|
||||||
- [Hugo](https://gohugo.io/documentation/)
|
|
||||||
|
|
||||||
## Can I get support?
|
|
||||||
|
|
||||||
Create a topic:
|
|
||||||
|
|
||||||
- [Netlify Community](https://community.netlify.com/)
|
|
||||||
- [Hugo Forums](https://discourse.gohugo.io/)
|
|
||||||
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
|
|
||||||
|
|
||||||
## Contact the creator?
|
|
||||||
|
|
||||||
Send `h-enk` a message:
|
|
||||||
|
|
||||||
- [Netlify Community](https://community.netlify.com/)
|
|
||||||
- [Hugo Forums](https://discourse.gohugo.io/)
|
|
||||||
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
---
|
|
||||||
title: "How to Update"
|
|
||||||
description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
|
|
||||||
lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
|
|
||||||
date: 2020-11-12T13:26:54+01:00
|
|
||||||
lastmod: 2020-11-12T13:26:54+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "help"
|
|
||||||
weight: 610
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
{{< alert icon="💡" text="Learn more about <a href=\"https://docs.npmjs.com/about-semantic-versioning\">semantic versioning</a> and <a href=\"https://docs.npmjs.com/cli/v6/using-npm/semver#advanced-range-syntax\">advanced range syntax</a>." />}}
|
|
||||||
|
|
||||||
## Check for outdated packages
|
|
||||||
|
|
||||||
The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm outdated [[<@scope>/]<pkg> ...]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Update packages
|
|
||||||
|
|
||||||
The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm update [<pkg>...]
|
|
||||||
```
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
---
|
|
||||||
title: "Troubleshooting"
|
|
||||||
description: "Solutions to common problems."
|
|
||||||
lead: "Solutions to common problems."
|
|
||||||
date: 2020-11-12T15:22:20+01:00
|
|
||||||
lastmod: 2020-11-12T15:22:20+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "help"
|
|
||||||
weight: 620
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Problems updating npm packages
|
|
||||||
|
|
||||||
Delete the `./node_modules` folder, and run again:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
## Problems with cache
|
|
||||||
|
|
||||||
Delete the temporary directories:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run clean
|
|
||||||
```
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
---
|
|
||||||
title: "Lorem"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T19:58:14+01:00
|
|
||||||
lastmod: 2022-01-18T19:58:14+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
---
|
|
||||||
title: "Ipsum"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T20:00:32+01:00
|
|
||||||
lastmod: 2022-01-18T20:00:32+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "lorem"
|
|
||||||
identifier: "ipsum"
|
|
||||||
weight: 999
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
---
|
|
||||||
title: "Amet"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T20:07:56+01:00
|
|
||||||
lastmod: 2022-01-18T20:07:56+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "ipsum"
|
|
||||||
identifier: "amet"
|
|
||||||
weight: 999
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
---
|
|
||||||
title: "Consectetur"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T20:17:32+01:00
|
|
||||||
lastmod: 2022-01-18T20:17:32+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "amet"
|
|
||||||
weight: 730
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
---
|
|
||||||
title: "Dolor"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T20:01:45+01:00
|
|
||||||
lastmod: 2022-01-18T20:01:45+01:00
|
|
||||||
draft: trus
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "ipsum"
|
|
||||||
weight: 700
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
---
|
|
||||||
title: "Sit"
|
|
||||||
description: ""
|
|
||||||
lead: ""
|
|
||||||
date: 2022-01-18T20:05:19+01:00
|
|
||||||
lastmod: 2022-01-18T20:05:19+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "ipsum"
|
|
||||||
weight: 710
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
---
|
|
||||||
title : "Prologue"
|
|
||||||
description: "Prologue Doks."
|
|
||||||
lead: ""
|
|
||||||
date: 2020-10-06T08:48:45+00:00
|
|
||||||
lastmod: 2020-10-06T08:48:45+00:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
weight: 100
|
|
||||||
---
|
|
||||||
|
|
@ -1,112 +0,0 @@
|
||||||
---
|
|
||||||
title: "Commands"
|
|
||||||
description: "Doks comes with commands for common tasks."
|
|
||||||
lead: "Doks comes with commands for common tasks."
|
|
||||||
date: 2020-10-13T15:21:01+02:00
|
|
||||||
lastmod: 2020-10-13T15:21:01+02:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "prologue"
|
|
||||||
weight: 130
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." />}}
|
|
||||||
|
|
||||||
## create
|
|
||||||
|
|
||||||
Create new content for your site:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run create [path] [flags]
|
|
||||||
```
|
|
||||||
|
|
||||||
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
|
|
||||||
|
|
||||||
### Docs based tree
|
|
||||||
|
|
||||||
Create a docs based tree — with a single command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run create -- --kind docs [section]
|
|
||||||
```
|
|
||||||
|
|
||||||
For example, create a docs based tree named guides:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run create -- --kind docs guides
|
|
||||||
```
|
|
||||||
|
|
||||||
## lint
|
|
||||||
|
|
||||||
Check scripts, styles, and markdown for errors:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run lint
|
|
||||||
```
|
|
||||||
|
|
||||||
### scripts
|
|
||||||
|
|
||||||
Check scripts for errors:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run lint:scripts [-- --fix]
|
|
||||||
```
|
|
||||||
|
|
||||||
### styles
|
|
||||||
|
|
||||||
Check styles for errors:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run lint:styles [-- --fix]
|
|
||||||
```
|
|
||||||
|
|
||||||
### markdown
|
|
||||||
|
|
||||||
Check markdown for errors:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run lint:markdown [-- --fix]
|
|
||||||
```
|
|
||||||
|
|
||||||
## clean
|
|
||||||
|
|
||||||
Delete temporary directories:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run clean
|
|
||||||
```
|
|
||||||
|
|
||||||
## start
|
|
||||||
|
|
||||||
Start local development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
## build
|
|
||||||
|
|
||||||
Build production website:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
### functions
|
|
||||||
|
|
||||||
Build Lambda functions:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build:functions
|
|
||||||
```
|
|
||||||
|
|
||||||
### preview
|
|
||||||
|
|
||||||
Build production website including draft and future content:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build:preview
|
|
||||||
```
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
---
|
|
||||||
title: "Introduction"
|
|
||||||
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
|
||||||
lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
|
||||||
date: 2020-10-06T08:48:57+00:00
|
|
||||||
lastmod: 2020-10-06T08:48:57+00:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "prologue"
|
|
||||||
weight: 100
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Get started
|
|
||||||
|
|
||||||
There are two main ways to get started with Doks:
|
|
||||||
|
|
||||||
### Tutorial
|
|
||||||
|
|
||||||
{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}}
|
|
||||||
|
|
||||||
Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
|
|
||||||
|
|
||||||
### Quick Start
|
|
||||||
|
|
||||||
{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}}
|
|
||||||
|
|
||||||
One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
|
|
||||||
|
|
||||||
## Go further
|
|
||||||
|
|
||||||
Recipes, Reference Guides, Extensions, and Showcase.
|
|
||||||
|
|
||||||
### Recipes
|
|
||||||
|
|
||||||
Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
|
|
||||||
|
|
||||||
### Reference Guides
|
|
||||||
|
|
||||||
Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
|
|
||||||
|
|
||||||
### Extensions
|
|
||||||
|
|
||||||
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
|
|
||||||
|
|
||||||
### Showcase
|
|
||||||
|
|
||||||
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
|
|
||||||
|
|
||||||
## Help
|
|
||||||
|
|
||||||
Get help on Doks. [Help →]({{< relref "how-to-update" >}})
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
---
|
|
||||||
title: "Quick Start"
|
|
||||||
description: "One page summary of how to start a new Doks project."
|
|
||||||
lead: "One page summary of how to start a new Doks project."
|
|
||||||
date: 2020-11-16T13:59:39+01:00
|
|
||||||
lastmod: 2020-11-16T13:59:39+01:00
|
|
||||||
draft: true
|
|
||||||
images: []
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
parent: "prologue"
|
|
||||||
weight: 110
|
|
||||||
toc: true
|
|
||||||
---
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
- [Git](https://git-scm.com/) — latest source release
|
|
||||||
- [Node.js](https://nodejs.org/) — latest LTS version or newer
|
|
||||||
|
|
||||||
{{< details "Why Node.js?" >}}
|
|
||||||
Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts.
|
|
||||||
{{< /details >}}
|
|
||||||
|
|
||||||
## Start a new Doks project
|
|
||||||
|
|
||||||
Create a new site, change directories, install dependencies, and start development server.
|
|
||||||
|
|
||||||
### Create a new site
|
|
||||||
|
|
||||||
Doks is available as a child theme and a starter theme.
|
|
||||||
|
|
||||||
#### Child theme
|
|
||||||
|
|
||||||
- Intended for novice to intermediate users
|
|
||||||
- Intended for minor customizations
|
|
||||||
- [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Starter theme
|
|
||||||
|
|
||||||
- Intended for intermediate to advanced users
|
|
||||||
- Intended for major customizations
|
|
||||||
- [Easily update npm packages]({{< relref "how-to-update" >}})
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/h-enk/doks.git my-doks-site
|
|
||||||
```
|
|
||||||
|
|
||||||
{{< details "Help me choose" >}}
|
|
||||||
Not sure which one is for you? Pick the child theme.
|
|
||||||
{{< /details >}}
|
|
||||||
|
|
||||||
### Change directories
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd my-doks-site
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install dependencies
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Start development server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run start
|
|
||||||
```
|
|
||||||
|
|
||||||
Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser.
|
|
||||||
|
|
||||||
## Other commands
|
|
||||||
|
|
||||||
Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})
|
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
title: "forum"
|
||||||
|
description: ""
|
||||||
|
lead: ""
|
||||||
|
date: 2022-01-25T14:41:21+01:00
|
||||||
|
lastmod: 2022-01-25T14:41:21+01:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
type: docs
|
||||||
|
weight: 40
|
||||||
|
---
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
title: "📢 Discussion & support"
|
||||||
|
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||||
|
lead: "Loi.re est un service en ligne pour permettre au plus de personne d'accéder à des outils numériques libre, vous trouverez de la documentation, des guides ainsi que des articles de blog vous permettant d'avoir un avis plus critique sur l'informatique."
|
||||||
|
date: 2020-10-06T08:48:57+00:00
|
||||||
|
lastmod: 2020-10-06T08:48:57+00:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "services"
|
||||||
|
weight: 100
|
||||||
|
toc: true
|
||||||
|
type: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: "Bienvenue !"
|
title: "Introduction"
|
||||||
description: ""
|
description: ""
|
||||||
lead: ""
|
lead: ""
|
||||||
date: 2022-01-25T14:41:21+01:00
|
date: 2022-01-25T14:41:21+01:00
|
||||||
|
|
@ -7,4 +7,5 @@ lastmod: 2022-01-25T14:41:21+01:00
|
||||||
draft: false
|
draft: false
|
||||||
images: []
|
images: []
|
||||||
type: docs
|
type: docs
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: "Introduction"
|
title: "👋 Bienvenue !"
|
||||||
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||||
lead: "Loi.re est un service en ligne pour permettre au plus de personne d'accéder à des outils numériques libre, vous trouverez de la documentation, des guides ainsi que des articles de blog vous permettant d'avoir un avis plus critique sur l'informatique."
|
lead: "Loi.re est un service en ligne pour permettre au plus de personne d'accéder à des outils numériques libre, vous trouverez de la documentation, des guides ainsi que des articles de blog vous permettant d'avoir un avis plus critique sur l'informatique."
|
||||||
date: 2020-10-06T08:48:57+00:00
|
date: 2020-10-06T08:48:57+00:00
|
||||||
|
|
@ -24,4 +24,5 @@ qu'aller jusqu'aux États-Unis.
|
||||||
Ce site WEB vous met à disposition de multiples services utiles pour collaborer,
|
Ce site WEB vous met à disposition de multiples services utiles pour collaborer,
|
||||||
partager et avoir une vie numérique plus « saine ».
|
partager et avoir une vie numérique plus « saine ».
|
||||||
|
|
||||||
N'hésitez pas à venir sur notre <a href="https://forum.loi.re">forum</a> ou nous écrire à <a href="mailto:support@loi.re">support@loi.re</a> pour toutes questions.
|
N'hésitez pas à venir sur notre <a href="https://forum.loi.re">forum</a> ou nous
|
||||||
|
écrire à <a href="mailto:support@loi.re">support@loi.re</a> pour toutes questions.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
title: "mdp"
|
||||||
|
description: ""
|
||||||
|
lead: ""
|
||||||
|
date: 2022-01-25T14:41:21+01:00
|
||||||
|
lastmod: 2022-01-25T14:41:21+01:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
type: docs
|
||||||
|
weight: 20
|
||||||
|
---
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
title: "Gestionnaire de mot de passe"
|
||||||
|
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||||
|
lead: "Loi.re est un service en ligne pour permettre au plus de personne d'accéder à des outils numériques libre, vous trouverez de la documentation, des guides ainsi que des articles de blog vous permettant d'avoir un avis plus critique sur l'informatique."
|
||||||
|
date: 2020-10-06T08:48:57+00:00
|
||||||
|
lastmod: 2020-10-06T08:48:57+00:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "services"
|
||||||
|
weight: 100
|
||||||
|
toc: true
|
||||||
|
type: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
title: "pdf"
|
||||||
|
description: ""
|
||||||
|
lead: ""
|
||||||
|
date: 2022-01-25T14:41:21+01:00
|
||||||
|
lastmod: 2022-01-25T14:41:21+01:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
type: docs
|
||||||
|
weight: 30
|
||||||
|
---
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
title: "Édition de fichier PDF"
|
||||||
|
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
||||||
|
lead: "Loi.re est un service en ligne pour permettre au plus de personne d'accéder à des outils numériques libre, vous trouverez de la documentation, des guides ainsi que des articles de blog vous permettant d'avoir un avis plus critique sur l'informatique."
|
||||||
|
date: 2020-10-06T08:48:57+00:00
|
||||||
|
lastmod: 2020-10-06T08:48:57+00:00
|
||||||
|
draft: false
|
||||||
|
images: []
|
||||||
|
menu:
|
||||||
|
docs:
|
||||||
|
parent: "services"
|
||||||
|
weight: 100
|
||||||
|
toc: true
|
||||||
|
type: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
@ -11,7 +11,7 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="col-lg-9 col-xl-8 text-center">
|
<div class="col-lg-9 col-xl-8 text-center">
|
||||||
<p class="lead">{{ .Params.lead | safeHTML }}</p>
|
<p class="lead">{{ .Params.lead | safeHTML }}</p>
|
||||||
<a class="btn btn-primary btn-lg px-4 mb-2" href="/docs/{{ if .Site.Params.options.docsVersioning }}{{ .Site.Params.docsVersion }}/{{ end }}introduction/bienvenue/" role="button">En savoir plus</a>
|
<a class="btn btn-primary btn-lg px-4 mb-2" href="/documentation/{{ if .Site.Params.options.docsVersioning }}{{ .Site.Params.docsVersion }}/{{ end }}introduction/bienvenue/" role="button">En savoir plus</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"defaults"
|
"defaults"
|
||||||
],
|
],
|
||||||
"repository": "https://github.com/h-enk/doks",
|
"repository": "https://git.resilien.fr/ResiLien/loi_re",
|
||||||
"license": "GPLv3",
|
"license": "GPLv3",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue