Elara6331
/
arsenm-dev-site
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
This repository has been archived on 2022-07-17. You can view files and clone it, but cannot push or open issues or pull requests.
1 Commit 1 Branch 0 Tags 868 KiB
HTML 86.4%
SCSS 11.7%
JavaScript 1.9%
Go to file
Elara 98666f3a08 Switch theme to Doks 2021-01-31 00:54:37 -08:00
.idea Switch theme to Doks 2021-01-31 00:54:37 -08:00
archetypes Switch theme to Doks 2021-01-31 00:54:37 -08:00
assets Switch theme to Doks 2021-01-31 00:54:37 -08:00
config Switch theme to Doks 2021-01-31 00:54:37 -08:00
content Switch theme to Doks 2021-01-31 00:54:37 -08:00
data Switch theme to Doks 2021-01-31 00:54:37 -08:00
images Switch theme to Doks 2021-01-31 00:54:37 -08:00
layouts Switch theme to Doks 2021-01-31 00:54:37 -08:00
resources/_gen/assets/scss/scss Switch theme to Doks 2021-01-31 00:54:37 -08:00
static Switch theme to Doks 2021-01-31 00:54:37 -08:00
.gitignore Switch theme to Doks 2021-01-31 00:54:37 -08:00
.gitmodules Switch theme to Doks 2021-01-31 00:54:37 -08:00
CHANGELOG.md Switch theme to Doks 2021-01-31 00:54:37 -08:00
CODE_OF_CONDUCT.md Switch theme to Doks 2021-01-31 00:54:37 -08:00
LICENSE Switch theme to Doks 2021-01-31 00:54:37 -08:00
README.md Switch theme to Doks 2021-01-31 00:54:37 -08:00
babel.config.js Switch theme to Doks 2021-01-31 00:54:37 -08:00
netlify.toml Switch theme to Doks 2021-01-31 00:54:37 -08:00
package-lock.json Switch theme to Doks 2021-01-31 00:54:37 -08:00
package.json Switch theme to Doks 2021-01-31 00:54:37 -08:00
theme.toml Switch theme to Doks 2021-01-31 00:54:37 -08:00

README.md

Doks

Doks

Modern documentation theme

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

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

Doks — Modern Documentation Theme

Demo

Quick start

Get your Doks site in 1 min.

Deploy to Netlify

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

Doks uses npm for dependency management and customized build scripts. Installing npm is pretty simple. Download and install Node.js (it includes npm) for your platform. I recommend installing the current release.

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.

Documentation

Communities

Blog