4f952d3476
|
||
|---|---|---|
| .github | ||
| archetypes | ||
| assets | ||
| config | ||
| content | ||
| data | ||
| images | ||
| layouts | ||
| static | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .markdownlint.json | ||
| .markdownlintignore | ||
| .npmrc | ||
| .stylelintignore | ||
| .stylelintrc.json | ||
| .versionrc.json | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
| babel.config.js | ||
| netlify.toml | ||
| package-lock.json | ||
| package.json | ||
| theme.toml | ||
README.md
Doks
Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
Demo
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 is a npm project. Installing npm is pretty simple: download and install Node.js (it includes npm) for your platform. The Long Term Support (LTS) release is recommended for most users, the Current release contains the latest features.
Get started
Have your local Doks site in three steps:
1. Create new Doks project
git clone https://github.com/h-enk/doks.git my-doks-site
2. Install npm packages
npm install
3. Start local development server
npm run start
Other commands
Doks comes with commands for common tasks.