mirror of
https://github.com/mudler/LocalAI.git
synced 2025-05-20 02:24:59 +00:00
docs/examples: enhancements (#1572)
* docs: re-order sections * fix references * Add mixtral-instruct, tinyllama-chat, dolphin-2.5-mixtral-8x7b * Fix link * Minor corrections * fix: models is a StringSlice, not a String Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * WIP: switch docs theme * content * Fix GH link * enhancements * enhancements * Fixed how to link Signed-off-by: lunamidori5 <118759930+lunamidori5@users.noreply.github.com> * fixups * logo fix * more fixups * final touches --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Signed-off-by: lunamidori5 <118759930+lunamidori5@users.noreply.github.com> Co-authored-by: lunamidori5 <118759930+lunamidori5@users.noreply.github.com>
This commit is contained in:
Ettore Di Giacinto
GitHub
parent
b5c93f176a
commit
6ca4d38a01
79 changed files with 1826 additions and 3546 deletions
0
docs/layouts/index.html
Normal file
0
docs/layouts/index.html
Normal file
47
docs/layouts/partials/docs/gitinfo.html
Normal file
47
docs/layouts/partials/docs/gitinfo.html
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
{{ $repoURL := slice .Site.Params.docs.repoURL }}
|
||||
{{ $repoHostname := (urls.Parse (.Site.Params.docs.repoURL)).Hostname }}
|
||||
{{ $filePath := replace .File.Path "\\" "/" }}
|
||||
{{ $iconPath := "" }}
|
||||
|
||||
{{ if strings.Contains ($repoHostname | lower) "github" }}
|
||||
{{ $repoURL = $repoURL | append "blob" (.Site.Params.docs.repoBranch | default "main") }}
|
||||
{{ $iconPath = "images/social/github_icon.svg" }}
|
||||
{{ else if strings.Contains ($repoHostname | lower) "gitlab" }}
|
||||
{{ $repoURL = $repoURL | append "-/blob" (.Site.Params.docs.repoBranch | default "main") }}
|
||||
{{ $iconPath = "images/social/gitlab_icon.svg" }}
|
||||
{{ else if strings.Contains ($repoHostname | lower) "bitbucket" }}
|
||||
{{ $repoURL = $repoURL | append "src" (.Site.Params.docs.repoBranch | default "master") }}
|
||||
{{ $iconPath = "images/social/bitbucket_icon.svg" }}
|
||||
{{ end }}
|
||||
|
||||
{{ $repoURL = $repoURL | append "docs/content" .Site.LanguagePrefix $filePath }}
|
||||
{{ $repoURL = delimit $repoURL "/" }}
|
||||
{{ $editPageURL := replaceRE "(https?://)|(/)+" "$1$2" $repoURL }}
|
||||
|
||||
<div class="gitinfo d-flex flex-wrap justify-content-between align-items-center opacity-85 {{ if or .Site.Params.docs.lastMod .Site.Params.docs.editPage -}}pt-3{{ else }}visually-hidden{{ end }}">
|
||||
{{ if .Site.Params.docs.editPage | default false -}}
|
||||
<div id="edit-this-page" class="mt-1">
|
||||
<a href="{{ $editPageURL }}" alt="{{ .Title }}" rel="noopener noreferrer" target="_blank">
|
||||
<!-- <span class="material-icons size-20 align-text-bottom text-primary">edit</span> -->
|
||||
<span class="me-1 align-text-bottom">
|
||||
{{ with resources.Get $iconPath }}
|
||||
{{ .Content | safeHTML }}
|
||||
{{ end }}
|
||||
</span>
|
||||
Edit this page
|
||||
<!-- <span class="material-icons size-20 align-text-bottom text-primary">open_in_new</span> -->
|
||||
</a>
|
||||
</div>
|
||||
{{ end }}
|
||||
{{ if .Site.Params.docs.lastMod | default false -}}
|
||||
<div id="last-modified" class="mt-1">
|
||||
<p class="mb-0 fw-semibold">Last updated <span
|
||||
{{ if .Site.Params.docs.lastModRelative | default true -}}id="relativetime"{{ else }}{{ end }}
|
||||
data-authdate="{{ dateFormat "2006-01-02T15:04:05Z0700" .GitInfo.AuthorDate }}"
|
||||
{{ if .Site.Params.docs.lastModRelative | default true -}}title="{{ dateFormat "02 Jan 2006, 15:04 MST" .GitInfo.AuthorDate }}"{{ else }}{{ end }}>
|
||||
{{ dateFormat "02 Jan 2006, 15:04 MST" .GitInfo.AuthorDate }}
|
||||
</span>. <span class="material-icons size-20 align-text-bottom opacity-75">history</span>
|
||||
</p>
|
||||
</div>
|
||||
{{ end }}
|
||||
</div>
|
||||
131
docs/layouts/partials/docs/sidebar.html
Normal file
131
docs/layouts/partials/docs/sidebar.html
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
<!-- sidebar-wrapper -->
|
||||
<nav id="sidebar" class="sidebar-wrapper">
|
||||
<div class="sidebar-brand d-md-flex justify-content-between align-items-center" style=" text-align: center; height: calc(35%);">
|
||||
<ul>
|
||||
<li>
|
||||
<a href='{{ with .Site.Params.docs.logoLinkURL }}{{ . }}{{ else }}{{ relLangURL "" }}{{ end }}' aria-label="HomePage" alt="HomePage">
|
||||
{{ with .Site.Params.docs.logo }}
|
||||
<img style="width: calc(65%);height: calc(65%);" src="{{ . }}">
|
||||
{{ end }}
|
||||
{{ with .Site.Params.docs.logo_text }}
|
||||
<p class="lead mb-3">{{ . }}</p>
|
||||
{{ end }}
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='https://github.com/go-skynet/LocalAI/releases'>
|
||||
<img src='https://img.shields.io/github/release/go-skynet/LocalAI?&label=Latest&style=for-the-badge'> </a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='https://hub.docker.com/r/localai/localai' target=_blank><img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker"></a>
|
||||
<a href='https://quay.io/repository/go-skynet/local-ai?tab=tags&tag=latest' target=_blank><img src="https://img.shields.io/badge/quay.io-images-important.svg?"></a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sidebar-content" style="height: calc(65%);">
|
||||
<ul class="sidebar-menu">
|
||||
{{ $currentPage := . -}}
|
||||
{{ $section := $currentPage.Section -}}
|
||||
{{ range (where .Site.Sections.ByWeight "Section" "in" $section) }}
|
||||
{{ $child_pages := union .Sections .Pages }}
|
||||
{{ range $child_pages.ByWeight }}
|
||||
{{ if or (.Sections) (.Pages) }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
<li class="sidebar-dropdown {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }} {{ if $active }}current active{{ end }}">
|
||||
<button class="btn">
|
||||
{{ if eq .Site.Params.docs.sidebarIcons true -}}
|
||||
<i class="material-icons me-2">{{- .Params.icon | default "notes" }}</i>
|
||||
{{ end }}
|
||||
{{- .Title }}
|
||||
</button>
|
||||
<div class="sidebar-submenu {{ if $active }}d-block{{ end }}">
|
||||
<ul>
|
||||
{{ range .Pages }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
{{ if .IsSection }}
|
||||
<li class="sidebar-dropdown nested {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }} {{ if $active }}current active{{ end }}">
|
||||
<button class="btn">
|
||||
{{ if eq .Site.Params.docs.sidebarIcons true -}}
|
||||
<!-- <span class="material-icons me-2">{{- .Params.icon }}</span> -->
|
||||
{{ end }}
|
||||
{{- .Title }}
|
||||
</button>
|
||||
<div class="sidebar-submenu {{ if $active }}d-block{{ end }}">
|
||||
<ul>
|
||||
{{ range .Pages }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
{{ if .IsSection }}
|
||||
<li class="sidebar-dropdown nested {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }} {{ if $active }}current active{{ end }}">
|
||||
<button class="btn">
|
||||
{{ if eq .Site.Params.docs.sidebarIcons true -}}
|
||||
<!-- <span class="material-icons me-2">{{- .Params.icon }}</span> -->
|
||||
{{ end }}
|
||||
{{- .Title }}
|
||||
</button>
|
||||
<div class="sidebar-submenu {{ if $active }}d-block{{ end }}">
|
||||
<ul>
|
||||
{{ range .Pages }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
{{ if .IsSection }}
|
||||
<li class="sidebar-dropdown nested {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }} {{ if $active }}current active{{ end }}">
|
||||
<button class="btn">
|
||||
{{ if eq .Site.Params.docs.sidebarIcons true -}}
|
||||
<!-- <span class="material-icons me-2">{{- .Params.icon }}</span> -->
|
||||
{{ end }}
|
||||
{{- .Title }}
|
||||
</button>
|
||||
<div class="sidebar-submenu {{ if $active }}d-block{{ end }}">
|
||||
<ul>
|
||||
{{ range .Pages }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
<li class="{{ if $active }}current{{ end }} {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }}"><a class="sidebar-nested-link" href="{{ .Permalink }}">{{ .Title }}</a></li>
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
{{ else }}
|
||||
<li class="{{ if $active }}current{{ end }} {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }}"><a class="sidebar-nested-link" href="{{ .Permalink }}">{{ .Title }}</a></li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
{{ else }}
|
||||
<li class="{{ if $active }}current{{ end }} {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }}"><a class="sidebar-nested-link" href="{{ .Permalink }}">{{ .Title }}</a></li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
{{ else }}
|
||||
<li class="{{ if $active }}current{{ end }} {{ if eq .Site.Params.docs.sidebarIcons true -}}{{ else }}no-icon{{ end }}"><a class="sidebar-nested-link" href="{{ .Permalink }}">{{ .Title }}</a></li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
{{ else }}
|
||||
{{ $active := in $currentPage.RelPermalink .RelPermalink }}
|
||||
<li class="{{ if $active }}current{{ end }}">
|
||||
<a class="sidebar-root-link" href="{{ .Permalink }}">
|
||||
{{ if eq .Site.Params.docs.sidebarIcons true -}}
|
||||
<i class="material-icons me-2">{{ .Params.icon }}</i>
|
||||
{{ end }}
|
||||
{{ .Title }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
<!-- sidebar-menu -->
|
||||
</div>
|
||||
<!-- Sidebar Footer -->
|
||||
<ul class="sidebar-footer list-unstyled mb-0">
|
||||
<!-- <li class="list-inline-item mb-0">
|
||||
<a href="javascript:void(0)" data-bs-toggle="modal" data-bs-target="#lang-selector-popup" class="btn btn-primary m-1">Language</a>
|
||||
</li> -->
|
||||
</ul>
|
||||
<!-- Sidebar Footer -->
|
||||
</nav>
|
||||
<!-- sidebar-wrapper -->
|
||||
62
docs/layouts/partials/head.html
Normal file
62
docs/layouts/partials/head.html
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>{{- .Site.Title }}</title>
|
||||
{{- if not hugo.IsProduction }}
|
||||
<meta name="robots" content="noindex">
|
||||
{{- end }}
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="description" content="A Lightweight, Modern Documentation Theme for Hugo" />
|
||||
<meta name="keywords" content="Documentation, Hugo, Hugo Theme, Bootstrap" />
|
||||
<meta name="author" content="Ettore Di Giacinto" />
|
||||
<meta name="email" content="info@localai.io" />
|
||||
<meta name="website" content="https://localai.io" />
|
||||
<meta name="Version" content="v0.1.0" />
|
||||
<!-- favicon -->
|
||||
{{ block "head/favicon" . }}{{ partialCached "head/favicon.html" . }}{{ end }}
|
||||
<!-- Google Fonts -->
|
||||
{{- partial "google-fonts" . }}
|
||||
<!-- Custom CSS -->
|
||||
{{- $options := dict "enableSourceMap" true }}
|
||||
{{- if hugo.IsProduction}}
|
||||
{{- $options := dict "enableSourceMap" false "outputStyle" "compressed" }}
|
||||
{{- end }}
|
||||
{{- $style := resources.Get "/scss/style.scss" }}
|
||||
{{- $style = $style | resources.ExecuteAsTemplate "/scss/style.scss" . | resources.ToCSS $options }}
|
||||
{{- if hugo.IsProduction }}
|
||||
{{- $style = $style | minify | fingerprint "sha384" }}
|
||||
{{- end -}}
|
||||
<link rel="stylesheet" href="{{ $style.RelPermalink }}" {{ if hugo.IsProduction }}integrity="{{ $style.Data.Integrity }}"{{ end -}}/>
|
||||
<!-- Bootstrap JS -->
|
||||
{{ $js := resources.Get "js/bootstrap.js" }}
|
||||
{{ $params := dict }}
|
||||
{{ $sourceMap := cond hugo.IsProduction "" "inline" }}
|
||||
{{ $opts := dict "sourceMap" $sourceMap "minify" hugo.IsProduction "target" "es2018" "params" $params }}
|
||||
{{ $js = $js | js.Build $opts }}
|
||||
{{ if hugo.IsProduction }}
|
||||
{{ $js = $js | fingerprint "sha384" }}
|
||||
{{ end }}
|
||||
<script src="{{ $js.RelPermalink }}" {{ if hugo.IsProduction }}integrity="{{ $js.Data.Integrity }}"{{ end -}} defer></script>
|
||||
<!-- Image Compare Viewer -->
|
||||
{{ if ($.Scratch.Get "image_compare_enabled") }}
|
||||
{{ $imagecompare := resources.Get "js/image-compare-viewer.min.js" }}
|
||||
{{- if not .Site.IsServer }}
|
||||
{{- $js := (slice $imagecompare) | resources.Concat "/js/image-compare.js" | minify | fingerprint "sha384" }}
|
||||
<script type="text/javascript" src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}"></script>
|
||||
{{- else }}
|
||||
{{- $js := (slice $imagecompare) | resources.Concat "/js/image-compare.js" }}
|
||||
<script type="text/javascript" src="{{ $js.Permalink }}" {{ if hugo.IsProduction }}integrity="{{ $js.Data.Integrity }}"{{ end }}></script>
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
<!-- Plausible Analytics Config -->
|
||||
{{- if not .Site.IsServer }}
|
||||
{{ if and (.Site.Params.plausible.scriptURL) (.Site.Params.plausible.dataDomain) -}}
|
||||
{{- partialCached "head/plausible" . }}
|
||||
{{- end -}}
|
||||
{{- end -}}
|
||||
<!-- Google Analytics v4 Config -->
|
||||
{{- if not .Site.IsServer }}
|
||||
{{- if .Site.GoogleAnalytics }}
|
||||
{{- template "_internal/google_analytics.html" . -}}
|
||||
{{- end -}}
|
||||
{{- end -}}
|
||||
</head>
|
||||
Loading…
Add table
Add a link
Reference in a new issue