diff --git a/README.md b/README.md index c72318c..42f58a6 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@
- 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.
@@ -42,7 +42,7 @@
## 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.
@@ -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.
+### Other features
+
+- __Multilingual and i18n__ support
+- __Versioning__ documentation support
+- __KaTeX__ math typesetting
+- __Mermaid__ diagrams and visualization
+- __highlight.js__ syntax highlighting
+
## 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:
@@ -120,3 +128,30 @@ Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for comm
- [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
+
+## Thanks
+
+
+
+
+
+Thanks to [Netlify](https://www.netlify.com/) for providing the hosting infrastructure.
+
+
+
+
+
+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)
+
diff --git a/config/_default/params.toml b/config/_default/params.toml
index 42cc484..fec8c77 100644
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -4,10 +4,10 @@
title = "Doks"
titleSeparator = "-"
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
-# docsVersion = "1.0"
+# docsVersion = "0.3"
## Open Graph
images = ["doks.png"]
diff --git a/content/en/_index.md b/content/en/_index.md
index db4b8c4..2e514e8 100644
--- a/content/en/_index.md
+++ b/content/en/_index.md
@@ -1,7 +1,7 @@
---
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."
-lead: "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 for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
date: 2020-10-06T08:47:36+00:00
lastmod: 2020-10-06T08:47:36+00:00
draft: false
diff --git a/content/en/docs/prologue/introduction.md b/content/en/docs/prologue/introduction.md
index f215533..53a7ed1 100644
--- a/content/en/docs/prologue/introduction.md
+++ b/content/en/docs/prologue/introduction.md
@@ -1,7 +1,7 @@
---
title: "Introduction"
-description: "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 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 for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
date: 2020-10-06T08:48:57+00:00
lastmod: 2020-10-06T08:48:57+00:00
draft: false
diff --git a/images/screenshot.png b/images/screenshot.png
index 5849cbb..072753b 100644
Binary files a/images/screenshot.png and b/images/screenshot.png differ
diff --git a/images/tn.png b/images/tn.png
index e51da8e..ff29c68 100644
Binary files a/images/tn.png and b/images/tn.png differ