From 1cec4237b395ff306b765d47b29b8410c2884921 Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Tue, 10 Nov 2020 08:31:21 +0100 Subject: [PATCH] docs: update reasons --- README.md | 8 +++++++- config/_default/params.toml | 2 +- content/docs/prologue/introduction.md | 8 +++++++- layouts/partials/footer/footer.html | 5 +---- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 827f401..854811e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Doks is a Hugo theme helping you build modern documentation websites that are se ## Why Doks? -Six reasons why you should use Doks: +Nine 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. @@ -22,6 +22,12 @@ Six reasons why you should use Doks: 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 Make sure all dependencies have been installed: diff --git a/config/_default/params.toml b/config/_default/params.toml index 0734137..038d59c 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -28,7 +28,7 @@ landscapePhotoWidths = [1000, 800, 700, 600, 500] portraitPhotoWidths = [800, 700, 600, 500] lqipWidth = "20x" -footer = "An open source project by @HenkVerlinde" +footer = "This site is powered by Hugo and the Doks theme." alert = false alertText = "Like Doks? Star on GitHub. Thanks!" diff --git a/content/docs/prologue/introduction.md b/content/docs/prologue/introduction.md index 96f877e..09527be 100644 --- a/content/docs/prologue/introduction.md +++ b/content/docs/prologue/introduction.md @@ -15,7 +15,7 @@ toc: true ## Why Doks? -Six reasons why you should use Doks: +Nine 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. @@ -29,6 +29,12 @@ Six reasons why you should use Doks: 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 Make sure all dependencies have been installed: diff --git a/layouts/partials/footer/footer.html b/layouts/partials/footer/footer.html index adfe715..e2bd32e 100644 --- a/layouts/partials/footer/footer.html +++ b/layouts/partials/footer/footer.html @@ -3,10 +3,7 @@
    - - -
  • This site is powered by Hugo and the Doks theme
    • - +
  • {{ .Site.Params.footer | safeHTML }}