mirror of
https://github.com/mudler/LocalAI.git
synced 2025-05-28 22:44:59 +00:00
Update lotusdocs and hugo
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
This commit is contained in:
parent
ccab1ecb4c
commit
603d7212db
9 changed files with 184 additions and 25 deletions
BIN
docs/assets/images/localai_screenshot.png
Normal file
BIN
docs/assets/images/localai_screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 282 KiB |
BIN
docs/assets/images/logos/logo.png
Normal file
BIN
docs/assets/images/logos/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 893 KiB |
|
@ -3,7 +3,7 @@
|
||||||
"baseUrl": ".",
|
"baseUrl": ".",
|
||||||
"paths": {
|
"paths": {
|
||||||
"*": [
|
"*": [
|
||||||
"../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2@v2.21100.20000/package/dist/cjs/popper.js/*",
|
"../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2@v2.21100.20000/package/dist/cjs/*",
|
||||||
"../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/bootstrap@v5.3.2+incompatible/js/*"
|
"../../../../.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/twbs/bootstrap@v5.3.2+incompatible/js/*"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
@ -108,6 +108,7 @@ defaultContentLanguage = 'en'
|
||||||
# indexName = "" # Index Name to perform search on (or set env variable HUGO_PARAM_DOCSEARCH_indexName)
|
# indexName = "" # Index Name to perform search on (or set env variable HUGO_PARAM_DOCSEARCH_indexName)
|
||||||
|
|
||||||
[params.analytics] # Parameters for Analytics (Google, Plausible)
|
[params.analytics] # Parameters for Analytics (Google, Plausible)
|
||||||
|
# google = "G-XXXXXXXXXX" # Replace with your Google Analytics ID
|
||||||
# plausibleURL = "/docs/s" # (or set via env variable HUGO_PARAM_ANALYTICS_plausibleURL)
|
# plausibleURL = "/docs/s" # (or set via env variable HUGO_PARAM_ANALYTICS_plausibleURL)
|
||||||
# plausibleAPI = "/docs/s" # optional - (or set via env variable HUGO_PARAM_ANALYTICS_plausibleAPI)
|
# plausibleAPI = "/docs/s" # optional - (or set via env variable HUGO_PARAM_ANALYTICS_plausibleAPI)
|
||||||
# plausibleDomain = "" # (or set via env variable HUGO_PARAM_ANALYTICS_plausibleDomain)
|
# plausibleDomain = "" # (or set via env variable HUGO_PARAM_ANALYTICS_plausibleDomain)
|
||||||
|
|
|
@ -2,38 +2,144 @@
|
||||||
|
|
||||||
# Hero
|
# Hero
|
||||||
hero:
|
hero:
|
||||||
enable: false
|
enable: true
|
||||||
weight: 10
|
weight: 10
|
||||||
template: hero
|
template: hero
|
||||||
|
|
||||||
|
backgroundImage:
|
||||||
|
path: "images/templates/hero"
|
||||||
|
filename:
|
||||||
|
desktop: "gradient-desktop.webp"
|
||||||
|
mobile: "gradient-mobile.webp"
|
||||||
|
|
||||||
|
# badge:
|
||||||
|
# text: v2.0.0
|
||||||
|
# color: primary
|
||||||
|
# pill: false
|
||||||
|
# soft: true
|
||||||
|
|
||||||
|
titleLogo:
|
||||||
|
path: "images/logos"
|
||||||
|
filename: "logo.png"
|
||||||
|
alt: "Lotus Docs Logo"
|
||||||
|
height: 80px
|
||||||
|
|
||||||
|
title: "LocalAI"
|
||||||
|
subtitle: A free, **Open Source** OpenAI alternative. Run **LLMs**, generate **images**, **audio** and more **locally** with consumer grade hardware.
|
||||||
|
|
||||||
|
image:
|
||||||
|
path: "images"
|
||||||
|
filename: "localai_screenshot.png"
|
||||||
|
alt: "LocalAI Screenshot"
|
||||||
|
boxShadow: true
|
||||||
|
rounded: true
|
||||||
|
|
||||||
|
ctaButton:
|
||||||
|
icon: rocket_launch
|
||||||
|
btnText: "Get Started"
|
||||||
|
url: "/basics/getting_started/"
|
||||||
|
cta2Button:
|
||||||
|
icon: code
|
||||||
|
btnText: "View on GitHub"
|
||||||
|
url: "https://github.com/mudler/LocalAI"
|
||||||
|
|
||||||
|
info: "**Open Source** MIT Licensed."
|
||||||
|
|
||||||
# Feature Grid
|
# Feature Grid
|
||||||
featureGrid:
|
featureGrid:
|
||||||
enable: false
|
enable: true
|
||||||
weight: 20
|
weight: 20
|
||||||
template: feature grid
|
template: feature grid
|
||||||
|
|
||||||
|
title: Why choose LocalAI?
|
||||||
|
subtitle: LocalAI provides a drop-in replacement REST API that's compatible with OpenAI API specifications for local AI inferencing. It's designed to be simple, efficient, and accessible.
|
||||||
|
|
||||||
|
items:
|
||||||
|
- title: OpenAI Compatible
|
||||||
|
icon: api
|
||||||
|
description: Drop-in replacement for OpenAI API. Compatible with existing applications and libraries.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: No GPU Required
|
||||||
|
icon: memory
|
||||||
|
description: Run on consumer grade hardware. No need for expensive GPUs or cloud services.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: Multiple Models
|
||||||
|
icon: hub
|
||||||
|
description: Support for various model families including LLMs, image generation, and audio models.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /docs/models
|
||||||
|
|
||||||
|
- title: Privacy Focused
|
||||||
|
icon: lock
|
||||||
|
description: Keep your data local. No data leaves your machine, ensuring complete privacy.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: Easy Setup
|
||||||
|
icon: settings
|
||||||
|
description: Simple installation and configuration. Get started in minutes with Docker or local installation.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: Community Driven
|
||||||
|
icon: groups
|
||||||
|
description: Active community support and regular updates. Contribute and help shape the future of LocalAI.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: https://github.com/mudler/LocalAI
|
||||||
|
|
||||||
|
- title: Flexible Deployment
|
||||||
|
icon: deploy
|
||||||
|
description: Deploy anywhere - from your laptop to your server. Supports Docker, Kubernetes, and more.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: Extensible
|
||||||
|
icon: extension
|
||||||
|
description: Easy to extend and customize. Add new models and features as needed.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: /basics/getting_started/
|
||||||
|
|
||||||
|
- title: Open Source
|
||||||
|
icon: code
|
||||||
|
description: MIT licensed. Free to use, modify, and distribute. Community contributions welcome.
|
||||||
|
ctaLink:
|
||||||
|
text: learn more
|
||||||
|
url: https://github.com/mudler/LocalAI
|
||||||
|
|
||||||
imageText:
|
imageText:
|
||||||
enable: true
|
enable: true
|
||||||
weight: 25
|
weight: 25
|
||||||
template: image text
|
template: image text
|
||||||
|
|
||||||
title: LocalAI
|
title: Run AI models locally with ease
|
||||||
subtitle: The Free, Open Source OpenAI Alternative
|
subtitle: LocalAI makes it simple to run various AI models on your own hardware, from text generation to image creation.
|
||||||
|
|
||||||
list:
|
list:
|
||||||
- text: Optimized, fast inference
|
- text: OpenAI API compatibility
|
||||||
icon: speed
|
icon: api
|
||||||
|
|
||||||
- text: Comprensive support for many models architectures
|
- text: Multiple model support
|
||||||
icon: area_chart
|
icon: hub
|
||||||
|
|
||||||
- text: Easy to deploy with Docker
|
- text: Privacy focused
|
||||||
icon: accessibility
|
icon: lock
|
||||||
|
|
||||||
image:
|
image:
|
||||||
path: "images/logos"
|
path: "images"
|
||||||
filename: "logo.png"
|
filename: "localai_architecture.png"
|
||||||
alt: "LocalAI logo" # Optional but recommended
|
alt: "LocalAI Architecture"
|
||||||
|
|
||||||
imgOrder:
|
imgOrder:
|
||||||
desktop: 2
|
desktop: 2
|
||||||
|
@ -41,10 +147,62 @@ imageText:
|
||||||
|
|
||||||
ctaButton:
|
ctaButton:
|
||||||
text: Learn more
|
text: Learn more
|
||||||
url: "/docs/"
|
url: "/basics/getting_started/"
|
||||||
|
|
||||||
# Image compare
|
# Image compare
|
||||||
imageCompare:
|
imageCompare:
|
||||||
enable: false
|
enable: true
|
||||||
weight: 30
|
weight: 30
|
||||||
template: image compare
|
template: image compare
|
||||||
|
|
||||||
|
title: LocalAI in Action
|
||||||
|
subtitle: See how LocalAI can transform your local AI experience with various models and capabilities.
|
||||||
|
|
||||||
|
items:
|
||||||
|
- title: Text Generation
|
||||||
|
config: {
|
||||||
|
startingPoint: 50,
|
||||||
|
addCircle: true,
|
||||||
|
addCircleBlur: false,
|
||||||
|
showLabels: true,
|
||||||
|
labelOptions: {
|
||||||
|
before: 'Input',
|
||||||
|
after: 'Output',
|
||||||
|
onHover: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
imagePath: "images/screenshots"
|
||||||
|
imageBefore: "text_generation_input.webp"
|
||||||
|
imageAfter: "text_generation_output.webp"
|
||||||
|
|
||||||
|
- title: Image Generation
|
||||||
|
config: {
|
||||||
|
startingPoint: 50,
|
||||||
|
addCircle: true,
|
||||||
|
addCircleBlur: false,
|
||||||
|
showLabels: true,
|
||||||
|
labelOptions: {
|
||||||
|
before: 'Prompt',
|
||||||
|
after: 'Result',
|
||||||
|
onHover: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
imagePath: "images/screenshots"
|
||||||
|
imageBefore: "image_generation_prompt.webp"
|
||||||
|
imageAfter: "image_generation_result.webp"
|
||||||
|
|
||||||
|
- title: Audio Generation
|
||||||
|
config: {
|
||||||
|
startingPoint: 50,
|
||||||
|
addCircle: true,
|
||||||
|
addCircleBlur: false,
|
||||||
|
showLabels: true,
|
||||||
|
labelOptions: {
|
||||||
|
before: 'Text',
|
||||||
|
after: 'Audio',
|
||||||
|
onHover: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
imagePath: "images/screenshots"
|
||||||
|
imageBefore: "audio_generation_text.webp"
|
||||||
|
imageAfter: "audio_generation_waveform.webp"
|
|
@ -82,7 +82,7 @@
|
||||||
</span>
|
</span>
|
||||||
</button>
|
</button>
|
||||||
{{ end -}}
|
{{ end -}}
|
||||||
{{ if .Site.IsMultiLingual }}
|
{{ if hugo.IsMultilingual }}
|
||||||
<div class="dropdown">
|
<div class="dropdown">
|
||||||
<button class="btn btn-link btn-default dropdown-toggle ps-2" type="button" data-bs-toggle="dropdown" aria-expanded="false">
|
<button class="btn btn-link btn-default dropdown-toggle ps-2" type="button" data-bs-toggle="dropdown" aria-expanded="false">
|
||||||
{{ site.Language.Lang | upper }}
|
{{ site.Language.Lang | upper }}
|
||||||
|
|
|
@ -18,10 +18,10 @@
|
||||||
<!-- Custom CSS -->
|
<!-- Custom CSS -->
|
||||||
{{- $options := dict "enableSourceMap" true }}
|
{{- $options := dict "enableSourceMap" true }}
|
||||||
{{- if hugo.IsProduction}}
|
{{- if hugo.IsProduction}}
|
||||||
{{- $options := dict "enableSourceMap" false "outputStyle" "compressed" }}
|
{{- $options = dict "enableSourceMap" false "outputStyle" "compressed" }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
{{- $style := resources.Get "/scss/style.scss" }}
|
{{- $style := resources.Get "/scss/style.scss" }}
|
||||||
{{- $style = $style | resources.ExecuteAsTemplate "/scss/style.scss" . | resources.ToCSS $options }}
|
{{- $style = $style | resources.ExecuteAsTemplate "/scss/style.scss" . | css.Sass $options }}
|
||||||
{{- if hugo.IsProduction }}
|
{{- if hugo.IsProduction }}
|
||||||
{{- $style = $style | minify | fingerprint "sha384" }}
|
{{- $style = $style | minify | fingerprint "sha384" }}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
@ -39,7 +39,7 @@
|
||||||
<!-- Image Compare Viewer -->
|
<!-- Image Compare Viewer -->
|
||||||
{{ if ($.Scratch.Get "image_compare_enabled") }}
|
{{ if ($.Scratch.Get "image_compare_enabled") }}
|
||||||
{{ $imagecompare := resources.Get "js/image-compare-viewer.min.js" }}
|
{{ $imagecompare := resources.Get "js/image-compare-viewer.min.js" }}
|
||||||
{{- if not .Site.IsServer }}
|
{{- if not hugo.IsDevelopment }}
|
||||||
{{- $js := (slice $imagecompare) | resources.Concat "/js/image-compare.js" | minify | fingerprint "sha384" }}
|
{{- $js := (slice $imagecompare) | resources.Concat "/js/image-compare.js" | minify | fingerprint "sha384" }}
|
||||||
<script type="text/javascript" src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}"></script>
|
<script type="text/javascript" src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}"></script>
|
||||||
{{- else }}
|
{{- else }}
|
||||||
|
@ -48,14 +48,14 @@
|
||||||
{{- end }}
|
{{- end }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
<!-- Plausible Analytics Config -->
|
<!-- Plausible Analytics Config -->
|
||||||
{{- if not .Site.IsServer }}
|
{{- if not hugo.IsDevelopment }}
|
||||||
{{ if and (.Site.Params.plausible.scriptURL) (.Site.Params.plausible.dataDomain) -}}
|
{{ if and (.Site.Params.plausible.scriptURL) (.Site.Params.plausible.dataDomain) -}}
|
||||||
{{- partialCached "head/plausible" . }}
|
{{- partialCached "head/plausible" . }}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
<!-- Google Analytics v4 Config -->
|
<!-- Google Analytics v4 Config -->
|
||||||
{{- if not .Site.IsServer }}
|
{{- if not hugo.IsDevelopment }}
|
||||||
{{- if .Site.GoogleAnalytics }}
|
{{- if .Site.Params.analytics.google }}
|
||||||
{{- template "_internal/google_analytics.html" . -}}
|
{{- template "_internal/google_analytics.html" . -}}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
[build]
|
[build]
|
||||||
[build.environment]
|
[build.environment]
|
||||||
HUGO_VERSION = "0.121.2"
|
HUGO_VERSION = "0.146.3"
|
||||||
GO_VERSION = "1.22.2"
|
GO_VERSION = "1.22.2"
|
||||||
|
|
2
docs/themes/lotusdocs
vendored
2
docs/themes/lotusdocs
vendored
|
@ -1 +1 @@
|
||||||
Subproject commit f5785a2399ca09e7fb4e7e3d69b397f85df42a24
|
Subproject commit 975da91e839cfdb5c20fb66961468e77b8a9f8fd
|
Loading…
Add table
Add a link
Reference in a new issue