ResiLien
/
portails
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
portails/content/docs/prologue/introduction.md

2.9 KiB
Raw Blame History

title description lead date lastmod draft images menu weight toc
Introduction Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default. Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default. 2020-10-06T08:48:57+00:00 2020-10-06T08:48:57+00:00 false
docs
parent
prologue
010 true

Why Doks?

Nine 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.

  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.

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:

npm install

Start local development server:

npm run start

Other commands

Doks comes with [commands for most used tasks]({{< ref "commands" >}}).

Quick start

Get your Doks site in 1 min.

Deploy to Netlify

Example site

👉 doks.netlify.app

Documentation

Communities