Skip to content

Testing deployment to Azure Static Web Apps using Hugo with Doks theme

License

Notifications You must be signed in to change notification settings

dagholmus/test-doks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Doks

Doks

Modern Documentation Theme

Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.

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

Doks — Modern Documentation Theme

Demo

Why Doks?

Nine main 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 5. Easily customize your Doks site with the source Sass files.

  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.

Other features

  • Multilingual and i18n support
  • Versioning documentation support
  • KaTeX math typesetting
  • Mermaid diagrams and visualization
  • highlight.js syntax highlighting

Requirements

  • Git — latest source release
  • Node.js — latest LTS version or newer
Why Node.js?

Doks uses npm (included with Node.js) to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts.

Get started

Start a new Doks project in three steps:

1. Create a new site

Doks is available as a child theme and a starter theme.

Child theme

git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site

Starter theme

git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site
Help me choose

Not sure which one is for you? Pick the child theme.

2. Install dependencies

npm install

3. Start development server

npm run start

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.

OC sponsor 0 OC sponsor 1

Backers

Support this project by becoming a backer. Your avatar will show up here.

Backers

About

Testing deployment to Azure Static Web Apps using Hugo with Doks theme

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published