-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(documentation-website): souin documentation (#492)
* feat(documentation): souin documentation website * feat(documentation): add some pages * feat(documentation): add the configuration page * feat(documentation): add middlewares and quickstart * feat(documentation): add souin logo * feat(deployment): setup for netlify * fix(website): redirect / to /docs/ to avoid the landing page * fix(documentation): change go-redis to rueidis according to the code * feat(docs): add caddy + wordpress * feat(docs): add wordpress caching setup * feat(docs): add otter storage page, rename wordpress x caddy endpoint
- Loading branch information
Showing
45 changed files
with
1,963 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.hugo_build.lock | ||
|
||
resources/_gen | ||
public |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
+++ | ||
title = '{{ replace .File.ContentBaseName "-" " " | title }}' | ||
date = {{ .Date }} | ||
+++ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
/* Template Name: Lotus Docs | ||
Author: Colin Wilson | ||
E-mail: colin@aigis.uk | ||
Created: October 2022 | ||
Version: 1.2.0 | ||
File Description: Main CSS file for Lotus Docs | ||
*/ | ||
|
||
// Custom Font Variables | ||
$font-family-secondary: {{ .Site.Params.secondary_font | default "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Helvetica Neue', 'Ubuntu'" }}; | ||
$font-family-sans-serif: {{ .Site.Params.sans_serif_font | default "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Helvetica Neue', 'Ubuntu'" }}; | ||
$font-family-monospace: {{ .Site.Params.mono_font | default "SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace" }}; | ||
|
||
// Code Padding Variables | ||
$code-block-padding-top: {{ if eq .Site.Params.docs.prism true -}}0{{ else }}1.25rem 0 0 0{{ end }}; | ||
|
||
// Icon Fonts | ||
@import "custom/plugins/icons/google-material"; | ||
|
||
// Core files | ||
@import "../../scss/bootstrap/functions"; | ||
@import "../../scss/bootstrap/variables"; | ||
@import {{ printf "'%s%s'" "custom/colors/" (.Site.Params.docs.themeColor | default "blue") }}; // current theme color | ||
@import "../../scss/bootstrap/mixins"; | ||
@import "../../scss/bootstrap/bootstrap"; | ||
@import "variables"; | ||
|
||
{{ if and (.Site.Params.docsearch.appID) (.Site.Params.docsearch.apiKey) -}} | ||
@import "custom/plugins/docsearch/style"; | ||
{{ end }} | ||
|
||
// Structure | ||
@import "custom/structure/general"; | ||
@import "custom/structure/content"; | ||
@import "custom/structure/sidebar"; | ||
@import "custom/structure/doc-nav"; | ||
@import "custom/structure/toc"; | ||
@import "custom/structure/footer"; | ||
|
||
// Components | ||
@import "custom/components/buttons"; | ||
@import "custom/components/breadcrumb"; | ||
@import "custom/components/badge"; | ||
@import "custom/components/backgrounds"; | ||
@import "custom/components/alerts"; | ||
@import "custom/components/card"; | ||
@import "custom/components/forms"; | ||
@import "custom/components/table"; | ||
@import "custom/components/tabs"; | ||
@import "custom/components/tooltip"; | ||
|
||
// Pages | ||
@import "custom/pages/features"; | ||
@import "custom/pages/helper"; | ||
|
||
// Plugins | ||
|
||
// Prism / Chroma | ||
{{- if eq .Site.Params.docs.prism true }} | ||
@import {{ printf "'%s%s'" "custom/plugins/prism/themes/" (.Site.Params.docs.prismTheme | default "lotusdocs") }}; // current prism theme | ||
@import "custom/plugins/prism/prism"; | ||
{{- else }} | ||
@import "custom/plugins/chroma/default"; | ||
{{- end -}} | ||
|
||
// FlexSearch | ||
{{ if or (not (isset .Site.Params.flexsearch "enabled")) (eq .Site.Params.flexsearch.enabled true) -}}@import "custom/plugins/flexsearch/flexsearch";{{ end }} | ||
|
||
// Feedback Widget | ||
{{ if .Site.Params.feedback.enabled | default false -}}@import "custom/plugins/feedback/feedback";{{ end}} | ||
|
||
// Mermaid | ||
@import "custom/plugins/mermaid/mermaid"; | ||
|
||
h1 { | ||
padding-top: 1em; | ||
padding-bottom: 1em; | ||
} | ||
|
||
h2 { | ||
padding-top: 0.5em; | ||
padding-bottom: 0.5em; | ||
} | ||
|
||
div.code-toolbar { | ||
border-radius: 1rem; | ||
& > pre { | ||
border-radius: 1rem !important; | ||
} | ||
} | ||
|
||
.top-header { | ||
backdrop-filter: blur(8px); | ||
-webkit-backdrop-filter: blur(8px); | ||
} | ||
|
||
#toc-mobile > ul { | ||
padding-left: 1rem; | ||
padding-right: 1rem; | ||
} | ||
|
||
#doc-nav { | ||
.doc-prev .card-title { | ||
margin-left: auto; | ||
} | ||
.doc-next .card-title { | ||
margin-right: auto; | ||
} | ||
|
||
.card-body { | ||
display: flex; | ||
|
||
.card-title { | ||
align-items: center; | ||
display: flex; | ||
} | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"compilerOptions": { | ||
"baseUrl": ".", | ||
"paths": { | ||
"*": [ | ||
"../../../../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2@v2.21100.20000/package/dist/cjs/popper.js/*", | ||
"../../../../../../../../Library/Caches/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/bootstrap@v5.3.2+incompatible/js/*" | ||
] | ||
} | ||
} | ||
} |
Oops, something went wrong.