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 87525dbff3 meta: update readme+ 2021-10-05 10:35:25 +02:00
.github Create FUNDING.yml 2021-08-12 17:28:38 +02:00
archetypes config: update sitemap changefreq 2020-12-02 13:49:08 +01:00
assets feat: add versioning setup 2021-09-28 16:26:15 +02:00
config meta: update readme+ 2021-10-05 10:35:25 +02:00
content meta: update readme+ 2021-10-05 10:35:25 +02:00
data feat: add versioning setup 2021-09-28 16:26:15 +02:00
functions feat: add hugo-installer + auto-changelog 2021-06-24 08:02:21 +02:00
i18n feat: add multilingual support 2021-09-10 16:38:32 +02:00
images meta: update readme+ 2021-10-05 10:35:25 +02:00
layouts config: switch versioning off per default 2021-10-04 16:29:39 +02:00
static fix: add doks.svg 2021-07-05 15:31:48 +02: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 deps: bump versions to latest 2021-09-03 13:42:43 +02: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
.stylelintignore feat: add flexsearch 2020-11-04 08:26:58 +01:00
.stylelintrc.json Initial commit 2020-04-15 15:48:16 +02:00
CHANGELOG.md meta: update changelog 2021-09-07 12:19:57 +02:00
CODE_OF_CONDUCT.md docs: update code of conduct 2020-12-09 09:32:04 +01:00
LICENSE Update LICENSE 2021-07-09 12:13:40 +02:00
README.md meta: update readme+ 2021-10-05 10:35:25 +02:00
SECURITY.md meta: add security policy 2021-10-05 08:11:03 +02:00
babel.config.js feat: add flexsearch 2020-11-04 08:26:58 +01:00
netlify.toml deps: bump versions to latest 2021-10-05 08:04:49 +02:00
package-lock.json deps: bump versions to latest 2021-10-05 08:04:49 +02:00
package.json deps: bump versions to latest 2021-10-05 08:04:49 +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 Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.

GitHub GitHub release (latest SemVer including pre-releases) npm (scoped) GitHub Workflow Status (branch) Netlify

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

Doks uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts:

  • 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

Doks is available as a child theme, and a starter theme:

  • Use the Doks child theme, if you do not plan to customize a lot, and/or need future Doks updates.
  • Use the Doks starter theme, if you plan to customize a lot, and/or do not need future Doks updates.

Not quite sure? Use the Doks child theme.

Doks child theme

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

Doks starter theme

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

Other commands

Doks comes with commands for common tasks.

Documentation

Communities

Thanks

Netlify Logo

Thanks to Netlify for providing the hosting infrastructure.

Algolia Logo

Thanks to Algolia for providing the documentation search.

Sponsors

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

OC sponsor 0

Backers

Thank you to all our backers! 🙏 [Become a backer]

Backers