Il est possible de lire la documentation dans [le dossier portails](https://git.resilien.fr/ResiLien/portails/src/branch/main/portails)

Go to file

Henk Verlinde d5ba148a21 Merge branch 'master' of github.com:h-enk/doks		2021-03-18 09:59:27 +01:00
.github	feat: add npm-package workflow	2021-03-18 09:56:39 +01:00
archetypes	config: update sitemap changefreq	2020-12-02 13:49:08 +01:00
assets	feat: add katex math typesetting	2021-03-16 15:14:45 +01:00
config	config: switch off katex per default	2021-03-17 11:03:35 +01:00
content	config: switch off katex per default	2021-03-17 11:03:35 +01:00
data	chore(release): 0.1.6	2021-03-01 10:50:09 +01:00
images	images: resize thumbnail	2020-12-29 16:05:08 +01:00
layouts	fix: script loading + script order	2021-03-17 08:59:47 +01:00
static	feat: add katex math typesetting	2021-03-16 15:14:45 +01:00
.editorconfig	Initial commit	2020-04-15 15:48:16 +02:00
.eslintignore	feat: add katex math typesetting	2021-03-16 15:14:45 +01:00
.eslintrc.json	feat: added options lazySizes, clipBoard, instantPage, flexSearch, and darkMode	2021-03-01 16:34:43 +01:00
.gitignore	feat: update netlify.toml for netlify-cli use	2021-03-17 15:32:42 +01:00
.markdownlint.json	feat: add flexsearch	2020-11-04 08:26:58 +01:00
.markdownlintignore	docs: update readme	2021-01-08 10:33:36 +01:00
.npmrc	feat: add hugo extended as a dependency	2021-01-12 11:31:13 +01:00
.stylelintignore	feat: add flexsearch	2020-11-04 08:26:58 +01:00
.stylelintrc.json	Initial commit	2020-04-15 15:48:16 +02:00
.versionrc.json	feat: add hugo extended as a dependency	2021-01-12 11:31:13 +01:00
CHANGELOG.md	chore(release): 0.1.6	2021-03-01 10:50:09 +01:00
CODE_OF_CONDUCT.md	docs: update code of conduct	2020-12-09 09:32:04 +01:00
LICENSE	legal: update copyright notice	2021-02-19 14:37:52 +01:00
README.md	docs: update requirements sections	2021-02-01 10:35:23 +01:00
babel.config.js	feat: add flexsearch	2020-11-04 08:26:58 +01:00
netlify.toml	feat: update netlify.toml for netlify-cli use	2021-03-17 15:35:22 +01:00
package-lock.json	feat: add npm-package workflow	2021-03-18 09:59:13 +01:00
package.json	feat: add npm-package workflow	2021-03-18 09:56:39 +01:00
theme.toml	feat: add hugothemes reqs	2020-12-04 18:01:10 +01:00

README.md

Doks

Modern documentation theme

Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

Demo

doks.netlify.app

Quick start

Get your Doks site in 1 min.

Why Doks?

Nine reasons why you should use Doks:

Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.
Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.
SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.
Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
Dark mode. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

Requirements

Doks uses npm to install dependencies and run commands. Installing npm is pretty simple. Download and install Node.js (it includes npm) for your platform.

Get started

Start a new Doks project in three steps:

1. Create a new site

git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site

2. Install dependencies

npm install

3. Start development server

npm run start