ResiLien/portails
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update reasons

Browse Source
This commit is contained in:
Henk Verlinde
2020-11-10 08:31:21 +01:00
parent 6705f4bbc4
commit 1cec4237b3
4 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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:

2
config/_default/params.toml
View File

@@ -28,7 +28,7 @@ landscapePhotoWidths = [1000, 800, 700, 600, 500]
portraitPhotoWidths = [800, 700, 600, 500]
lqipWidth = "20x"
footer = "An open source project by <a href=\"https://twitter.com/henkverlinde\">@HenkVerlinde</a>"
footer = "This site is powered by <a href=\"https://gohugo.io/\">Hugo</a> and the <a href=\"https://getdoks.org/\">Doks</a> theme."
alert = false
alertText = "Like Doks? <a class=\"alert-link\" href=\"https://github.com/h-enk/doks/stargazers\">Star on GitHub</a>. Thanks!</a>"

8
content/docs/prologue/introduction.md
View File

@@ -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:

5
layouts/partials/footer/footer.html
View File

@@ -3,10 +3,7 @@
<div class="row">
<div class="col-lg-16 text-center">
<ul class="list-inline">
<!-- <li class="list-inline-item">{{ .Site.Params.footer | safeHTML }}</li> -->
<!-- <li class="list-inline-item"><a href="{{ "privacy-policy" | absURL }}">Privacy</a></li> -->
<li class="list-inline-item">This site is powered by <a href="https://gohugo.io/">Hugo</a> and the <a href="https://getdoks.org/">Doks</a> theme</li>
<!-- <li class="list-inline-item"><a href="https://gethyas.com/">This site is powered by Hyas</a></li> -->
<li class="list-inline-item">{{ .Site.Params.footer | safeHTML }}</li>
</ul>
</div>
</div>