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 6efd117075 meta: update CHANGELOG.md 2023-05-26 17:45:26 +02:00
.github ops: update GitHub Actions 2023-04-18 15:31:08 +02:00
config feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
content feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
i18n feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
images meta: update screenshot README.md 2022-07-01 13:53:05 +02:00
integrations feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
static feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
themes/doks feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
.editorconfig Initial commit 2020-04-15 15:48:16 +02:00
.eslintignore feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.eslintrc.json feat: added options lazySizes, clipBoard, instantPage, flexSearch, and darkMode 2021-03-01 16:34:43 +01:00
.gitignore feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.gitpod.yml feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.markdownlint-cli2.jsonc feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.npmignore feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.npmrc feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.stylelintignore feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
.stylelintrc.json feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
CHANGELOG.md meta: update CHANGELOG.md 2023-05-26 17:45:26 +02:00
CODE_OF_CONDUCT.md docs: update code of conduct 2020-12-09 09:32:04 +01:00
LICENSE feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
README.md feat: update for doks v1.0.0-alpha.1 2023-04-18 15:10:33 +02:00
SECURITY.md meta: add security policy 2021-10-05 08:11:03 +02:00
netlify.toml config: update content security policy 2023-05-23 15:05:47 +02:00
package.json feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
pnpm-lock.yaml feat: update for doks 1.0.0-beta.1 2023-05-26 17:44:05 +02:00
theme.toml config: remove homepage trailing slash 2021-07-05 10:01:36 +02:00

README.md

Doks

Doks

Modern Documentation Theme

Doks is a documentation theme for Hyas — the Hugo-powered Jamstack framework for building production-ready websites.

GitHub GitHub release (latest SemVer including pre-releases)

Doks — Modern Documentation Theme

Demo

Why Doks?

Nine main reasons why you should use Doks:

  1. Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.

  2. Fast by default. Get 100 scores on Google Lighthouse 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

Get started

Start a new Doks project in three steps:

npm create hyas@latest my-doks-site -- --template doks-recommended

2. Install dependencies

npm install

3. Start development server

npm run dev

Other commands

Doks comes with commands for common tasks.

Documentation

Communities

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

OC sponsor 0 OC sponsor 1

Backers

Support this project by becoming a backer. Your avatar will show up here.

Backers