diff --git a/docSite/assets/docs/scss/style.scss b/docSite/assets/docs/scss/style.scss index a703f8eac..20b2c4ebf 100644 --- a/docSite/assets/docs/scss/style.scss +++ b/docSite/assets/docs/scss/style.scss @@ -48,15 +48,30 @@ $code-block-padding-top: {{ if eq .Site.Params.docs.prism true -}}0{{ else }}1.2 @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 -{{ if eq .Site.Params.docs.prism true -}}@import "custom/plugins/prism/prism";{{ end }} + +// 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"; + +// change @import "custom/pages/custom"; \ No newline at end of file diff --git a/docSite/assets/imgs/functional-arch.webp b/docSite/assets/imgs/functional-arch.webp new file mode 100644 index 000000000..24d1eea47 Binary files /dev/null and b/docSite/assets/imgs/functional-arch.webp differ diff --git a/docSite/assets/imgs/sealos-fastgpt.webp b/docSite/assets/imgs/sealos-fastgpt.webp new file mode 100644 index 000000000..f514eff01 Binary files /dev/null and b/docSite/assets/imgs/sealos-fastgpt.webp differ diff --git a/docSite/content/docs/installation/sealos.md b/docSite/content/docs/installation/sealos.md index 4e0f38012..3ecc95770 100644 --- a/docSite/content/docs/installation/sealos.md +++ b/docSite/content/docs/installation/sealos.md @@ -21,4 +21,8 @@ Sealos 的服务器在国外,不需要额外处理网络问题,无需服务 > 用户名:`root` > -> 密码就是刚刚一键部署时设置的环境变量 \ No newline at end of file +> 密码就是刚刚一键部署时设置的环境变量 + +## 部署架构图 + +![](/imgs/sealos-fastgpt.webp) \ No newline at end of file diff --git a/docSite/content/docs/intro.md b/docSite/content/docs/intro.md index 5d80bbb80..007e360ee 100644 --- a/docSite/content/docs/intro.md +++ b/docSite/content/docs/intro.md @@ -78,7 +78,7 @@ FastGPT 对外的 API 接口对齐了 OpenAI 官方接口,可以直接接入 ## 知识库核心流程图 -![](/imgs/KBProcess.jpg) +![](/imgs/functional-arch.webp) ## 免责声明 diff --git a/docSite/hugo.toml b/docSite/hugo.toml index d3670f804..ba6fbbaec 100644 --- a/docSite/hugo.toml +++ b/docSite/hugo.toml @@ -72,12 +72,14 @@ defaultContentLanguage = 'zh-cn' # pathName = "docs" # path name for documentation site | default "docs" - # themeColor = "cyan" # (optional) - Set theme accent colour. Options include: blue (default), green, red, yellow, emerald, cardinal, magenta, cyan + # themeColor = "blue" # (optional) - Set theme accent colour. Options include: blue (default), green, red, yellow, emerald, cardinal, magenta, cyan darkMode = true # enable dark mode option? default false prism = true # enable syntax highlighting via Prism + prismTheme = "lotusdocs" # (optional) - Set theme for PrismJS. Options include: lotusdocs (default), solarized-light, twilight, lucario + # gitinfo repoURL = "https://github.com/labring/FastGPT" # Git repository URL for your site repoBranch = "main" # Name of your Git repository branch diff --git a/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content b/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content index 17a0863a4..3b50d857b 100644 --- a/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content +++ b/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content @@ -19,6 +19,7 @@ --primary-100: var(--blue-100); --primary-200: var(--blue-200); --primary-300: var(--blue-300); + --primary-400: var(--blue-400); --primary-800: var(--blue-800); --primary-hsl: var(--blue-500-hsl); --primary-50-hsl: var(--blue-50-hsl); @@ -9765,7 +9766,6 @@ i.title-icon { .docs-content .main-content code { font-size: inherit; - color: var(--text-default); font-weight: 400; padding: 1px 2px; background: var(--inline-code-bg); @@ -9774,14 +9774,11 @@ i.title-icon { .docs-content .main-content pre { margin: 0; - background-color: var(--code-block-bg) !important; border-radius: 4px; padding: 0; } .docs-content .main-content pre code { - color: #f5fbff; font-size: 0.8rem; display: block; - background: var(--code-block-bg); border: none; overflow-x: auto; line-height: 1.5; @@ -10820,6 +10817,43 @@ table td:last-child, table th:last-child { .tab-content { margin-bottom: 0.8rem; } +:root { + --tooltip-bg: var(--white); + --tooltip-border-color: var(--content-link-color); + --tooltip-drop-shadow-color: var(--gray-500); + --tooltip-link-color: var(--gray-700); } + +[data-dark-mode] { + --tooltip-bg: var(--dark-alt); + --tooltip-border-color: var(--primary-300); + --tooltip-drop-shadow-color: var(--gray-900); + --tooltip-link-color: var(--gray-500); } + +.tooltip { + --bs-tooltip-bg: var(--tooltip-bg); + --bs-tooltip-opacity: 1.0; + --bs-tooltip-font-size: 0.575rem; + --bs-tooltip-max-width: 300px; } + +.tooltip-inner { + text-align: left; + border: 2px solid var(--tooltip-border-color); + border-width: 2px 2px 2px 8px; + filter: drop-shadow(4px 4px 5px var(--tooltip-drop-shadow-color)); + --bs-tooltip-border-radius: 4px; } + .tooltip-inner a { + color: var(--tooltip-link-color); + font-size: 0.85rem; + line-height: 1.55; } + .tooltip-inner a p { + margin-bottom: 0.2rem; + color: var(--text-muted); + font-weight: 600; } + .tooltip-inner a strong { + font-size: 0.975rem; + line-height: 2; + color: var(--text-default); } + :root { --feature-icon-color: var(--primary); --feature-icon-faint: var(--gray-200); @@ -11217,11 +11251,14 @@ h4:hover a, visibility: visible; text-decoration: none; } -/* PrismJS 1.29.0 /** - * prism.js lotus docs for JavaScript, CoffeeScript, CSS and HTML - * Based on https://github.com/chriskempson/tomorrow-theme - * @author Colin Wilson + * Lotus Docs theme + * + * Adapted from a theme based on: + * https://github.com/chriskempson/tomorrow-theme + * + * @author Colin Wilson + * @version 1.0 */ :root { --prism-code-bg: #212d63; @@ -11234,35 +11271,7 @@ h4:hover a, code[class*="language-"], pre[class*="language-"] { color: #f5fbff !important; - background: var(--prism-code-bg) !important; - border: none !important; - font-family: JetBrains Mono; - font-size: 0.8rem; - text-align: left; - white-space: pre; - word-spacing: normal; - word-break: normal; - word-wrap: normal; - line-height: 1.5; - -moz-tab-size: 4; - -o-tab-size: 4; - tab-size: 4; - -webkit-hyphens: none; - -moz-hyphens: none; - -ms-hyphens: none; - hyphens: none; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; - text-rendering: optimizeLegibility; - scrollbar-width: thin; - scrollbar-color: var(--prism-code-scrollbar-thumb-color) var(--prism-code-bg); } - code[class*="language-"]::-webkit-scrollbar, - pre[class*="language-"]::-webkit-scrollbar { - height: 5px; - background: var(--prism-code-bg); } - code[class*="language-"]::-webkit-scrollbar-thumb, - pre[class*="language-"]::-webkit-scrollbar-thumb { - background: var(--prism-code-scrollbar-thumb-color); } + background: var(--prism-code-bg) !important; } /* Code blocks */ pre[class*="language-"] { @@ -11279,6 +11288,19 @@ pre[class*="language-"] { border-radius: .3em; white-space: normal; } +.line-highlight:before, +.line-highlight[data-end]:after { + background-color: var(--blue-400); } + +[data-copy-state="copy"] span:empty::before { + background-color: var(--gray-400); } + +[data-copy-state="copy"] span:empty:hover::before { + background-color: var(--white); } + +[data-copy-state="copy-success"] span:empty::before { + background-color: var(--emerald-200); } + .token.comment, .token.block-comment, .token.prolog, @@ -11347,6 +11369,44 @@ pre[class*="language-"] { .token.inserted { color: green; } +/* PrismJS 1.29.0 */ +code { + color: var(--text-default); } + +.docs-content .main-content pre { + background-color: var(--prism-code-bg) !important; } + +code[class*="language-"], +pre[class*="language-"] { + border: none !important; + font-family: JetBrains Mono; + font-size: 0.8rem; + text-align: left; + white-space: pre; + word-spacing: normal; + word-break: normal; + word-wrap: normal; + line-height: 1.5; + -moz-tab-size: 4; + -o-tab-size: 4; + tab-size: 4; + -webkit-hyphens: none; + -moz-hyphens: none; + -ms-hyphens: none; + hyphens: none; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + text-rendering: optimizeLegibility; + scrollbar-width: thin; + scrollbar-color: var(--prism-code-scrollbar-thumb-color) var(--prism-code-bg); } + code[class*="language-"]::-webkit-scrollbar, + pre[class*="language-"]::-webkit-scrollbar { + height: 5px; + background: var(--prism-code-bg); } + code[class*="language-"]::-webkit-scrollbar-thumb, + pre[class*="language-"]::-webkit-scrollbar-thumb { + background: var(--prism-code-scrollbar-thumb-color); } + pre[data-line] { position: relative; padding: 0 !important; } @@ -11387,7 +11447,6 @@ pre[data-line] { left: .6em; min-width: 1.5em; padding: 0 .5em; - background-color: var(--blue-400); color: #f5f2f0; font: bold 95%/1.3 sans-serif; text-align: center; @@ -11510,21 +11569,16 @@ div.code-toolbar > .toolbar > .toolbar-item > button { mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' height='48' width='48' viewBox='0 0 48 48'%3E%3Cpath d='M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z'/%3E%3C/svg%3E"); -webkit-mask-size: contain; mask-size: contain; - background-color: var(--gray-400); display: block; height: 24px; width: 24px; } -[data-copy-state="copy"] span:empty:hover::before { - background-color: var(--white); } - [data-copy-state="copy-success"] span:empty::before { content: ""; -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' height='48' width='48' viewBox='0 0 48 48'%3E%3Cpath d='M18.9 35.7 7.7 24.5l2.15-2.15 9.05 9.05 19.2-19.2 2.15 2.15Z'/%3E%3C/svg%3E"); mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' height='48' width='48' viewBox='0 0 48 48'%3E%3Cpath d='M18.9 35.7 7.7 24.5l2.15-2.15 9.05 9.05 19.2-19.2 2.15 2.15Z'/%3E%3C/svg%3E"); -webkit-mask-size: contain; mask-size: contain; - background-color: var(--emerald-200); display: block; height: 24px; width: 24px; } @@ -11918,6 +11972,33 @@ div.code-toolbar > .toolbar > .toolbar-item > span:focus { width: 20.1rem; padding-left: 1rem; } } +/* Mermaid */ +.docs-content .main-content pre.mermaid { + background-color: transparent !important; + text-align: center !important; } + .docs-content .main-content pre.mermaid .messageText { + fill: var(--text-default) !important; } + .docs-content .main-content pre.mermaid .messageLine0, + .docs-content .main-content pre.mermaid .messageLine1 { + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid #arrowhead path, + .docs-content .main-content pre.mermaid #crosshead path { + fill: var(--text-default) !important; + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid .edgePaths path { + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid .marker { + fill: var(--text-default) !important; + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid .grid .tick { + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid .grid .tick text { + fill: var(--text-default) !important; } + .docs-content .main-content pre.mermaid line { + stroke: var(--text-default) !important; } + .docs-content .main-content pre.mermaid text { + fill: var(--text-default) !important; } + .docs-content .main-content img, .docs-content .main-content svg:not(.gitinfo svg):not(a svg) { max-width: 80% !important; height: auto;