meta: update readme+

This commit is contained in:
Henk Verlinde 2021-10-05 10:35:25 +02:00
parent f9bf4eaef3
commit 87525dbff3
6 changed files with 44 additions and 9 deletions

View File

@ -9,11 +9,11 @@
</h1> </h1>
<h3 align="center"> <h3 align="center">
Modern documentation theme Modern Documentation Theme
</h3> </h3>
<p align="center"> <p align="center">
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 for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
</p> </p>
<p align="center"> <p align="center">
@ -42,7 +42,7 @@
## Why Doks? ## Why Doks?
Nine reasons why you should use Doks: Nine main reasons why you should use Doks:
1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs. 1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
@ -62,6 +62,14 @@ Nine reasons why you should use Doks:
9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. 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 ## Requirements
Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts: Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts:
@ -120,3 +128,30 @@ Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for comm
- [Netlify Community](https://community.netlify.com/) - [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/) - [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions) - [Doks Discussions](https://github.com/h-enk/doks/discussions)
## Thanks
<a href="https://www.netlify.com/">
<img src="https://cdn.netlify.com/15ecf59b59c9d04b88097c6b5d2c7e8a7d1302d0/1b6d6/img/press/logos/full-logo-light.svg" width="110.25" height="30" alt="Netlify Logo">
</a>
Thanks to [Netlify](https://www.netlify.com/) for providing the hosting infrastructure.
<a href="https://www.algolia.com/">
<img src="https://res.cloudinary.com/hilnmyskv/image/upload/q_auto/v1631888269/Algolia_com_Website_assets/images/shared/algolia_logo/logo-algolia-nebula-blue-full.svg" width="97" height="30" alt="Algolia Logo">
</a>
Thanks to [Algolia](https://www.algolia.com/) for providing the documentation search.
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/doks)]
[![OC sponsor 0](https://opencollective.com/doks/sponsor/0/avatar.svg)](https://opencollective.com/doks/sponsor/0/website)
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/doks)]
[![Backers](https://opencollective.com/doks/backers.svg)](https://opencollective.com/doks)

View File

@ -4,10 +4,10 @@
title = "Doks" title = "Doks"
titleSeparator = "-" titleSeparator = "-"
titleAddition = "Modern Documentation Theme" titleAddition = "Modern Documentation Theme"
description = "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." description = "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
## Documentation ## Documentation
# docsVersion = "1.0" # docsVersion = "0.3"
## Open Graph ## Open Graph
images = ["doks.png"] images = ["doks.png"]

View File

@ -1,7 +1,7 @@
--- ---
title : "Modern Documentation Theme" title : "Modern Documentation Theme"
description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
date: 2020-10-06T08:47:36+00:00 date: 2020-10-06T08:47:36+00:00
lastmod: 2020-10-06T08:47:36+00:00 lastmod: 2020-10-06T08:47:36+00:00
draft: false draft: false

View File

@ -1,7 +1,7 @@
--- ---
title: "Introduction" title: "Introduction"
description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
date: 2020-10-06T08:48:57+00:00 date: 2020-10-06T08:48:57+00:00
lastmod: 2020-10-06T08:48:57+00:00 lastmod: 2020-10-06T08:48:57+00:00
draft: false draft: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 KiB

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

After

Width:  |  Height:  |  Size: 138 KiB