f45dfa1783
|
||
|---|---|---|
| .github | ||
| config | ||
| content | ||
| i18n | ||
| images | ||
| integrations | ||
| static | ||
| themes/doks | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitpod.yml | ||
| .markdownlint-cli2.jsonc | ||
| .npmignore | ||
| .npmrc | ||
| .stylelintignore | ||
| .stylelintrc.json | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| netlify.toml | ||
| package.json | ||
| pnpm-lock.yaml | ||
| theme.toml | ||
README.md
Doks
Modern Documentation Theme
Doks is a documentation theme for Hyas — the Hugo-powered Jamstack framework for building production-ready websites.
Demo
Why Doks?
Nine main 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 5. Easily customize your Doks site with the source Sass files.
-
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.
Other features
- Multilingual and i18n support
- Versioning documentation support
- KaTeX math typesetting
- Mermaid diagrams and visualization
- highlight.js syntax highlighting
Requirements
- Node.js — v16.17.0 or higher
Get started
Start a new Doks project in three steps:
1. Scaffold a Doks project with recommended plugins
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.
Backers
Support this project by becoming a backer. Your avatar will show up here.
