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 b7d1c520d5 test: update ci 2020-11-05 12:10:00 +01:00
.github test: update ci 2020-11-05 12:10:00 +01:00
archetypes feat: add flexsearch 2020-11-04 08:26:58 +01:00
assets feat: add flexsearch 2020-11-04 08:26:58 +01:00
config feat: update static assets 2020-11-04 14:23:52 +01:00
content blog: update post 2020-11-04 09:28:34 +01:00
data Initial commit 2020-04-15 15:48:16 +02:00
layouts fix: update file path 2020-11-04 09:26:22 +01:00
static feat: update static assets 2020-11-04 14:23:52 +01:00
.editorconfig Initial commit 2020-04-15 15:48:16 +02:00
.eslintignore feat: add flexsearch 2020-11-04 08:26:58 +01:00
.eslintrc.json Initial commit 2020-04-15 15:48:16 +02:00
.gitignore Initial commit 2020-04-15 15:48:16 +02:00
.markdownlint.json feat: add flexsearch 2020-11-04 08:26:58 +01:00
.markdownlintignore feat: add flexsearch 2020-11-04 08:26:58 +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 config: add types 2020-11-04 16:46:21 +01:00
CHANGELOG.md feat: add flexsearch 2020-11-04 08:26:58 +01:00
CODE_OF_CONDUCT.md feat: add flexsearch 2020-11-04 08:26:58 +01:00
LICENSE feat: add flexsearch 2020-11-04 08:26:58 +01:00
README.md test: update ci 2020-11-05 12:10:00 +01:00
babel.config.js feat: add flexsearch 2020-11-04 08:26:58 +01:00
netlify.toml deps: bump versions 2020-11-04 14:12:21 +01:00
package-lock.json test: update ci 2020-11-05 10:25:48 +01:00
package.json feat: add standard-version 2020-11-04 09:27:49 +01:00

README.md

Doks

GitHub release

GitHub Workflow Status (branch)

Netlify

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

Why Doks?

Six 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. Or use any other front-end framework if you prefer.

  6. Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.

Requirements

Make sure all dependencies have been installed:

  • Hugo >= 0.75.0/extended
  • Node.js >= 14.15.0 (needed to install npm packages and run commands)

Get started

Create a new Doks project:

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

Install npm packages:

# @ my-doks-site/
$ npm install

Start local development server:

# @ my-doks-site/
$ npm run start

Other commands

  • npm run lint:styles - Check Sass for errors
  • npm run lint:scripts - Check JavaScript for errors
  • npm run clean - Delete temporary directories
  • npm run build - Build production website

Quick start

Get your Doks site in 1 min.

Deploy to Netlify

Example site

👉 doks.netlify.app

Documentation

Communities