Merge branch 'main' into docs/assistants-api-reference
This commit is contained in:
commit
c4d78f7cc6
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: About Jan
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
Jan believes in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to compete on a level playing field with proprietary ones.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Community
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
- [ ] Social media links
|
||||
@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Build an Assistant
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Extending Jan
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Model Management
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Build a Module
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: API Server
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Build a Theme
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
@ -1,3 +1,5 @@
|
||||
---
|
||||
title: Build a Tool
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Engineering
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Connecting to Rigs
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Onboarding Checklist
|
||||
slug: /handbook
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
# Welcome
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Hardware Examples
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Add your own example
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: From Source
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
# Install Jan from Source
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Linux
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
# Installing Jan on Linux
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Mac
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
# Installing Jan on MacOS
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Overview
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
Getting up and running open-source AI models on your own computer with Jan is quick and easy. Jan is lightweight and can run on a variety of hardware and platform versions. Specific requirements tailored to your platform are outlined below.
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Windows
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
# Installing Jan on Windows
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: How Jan Works
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
- Local Filesystem
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Introduction
|
||||
slug: /docs
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api).
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Quickstart
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
- Write in the style of comics, explanation
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Architecture
|
||||
slug: /specs
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Assistants"
|
||||
slug: /specs/assistants
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Chats
|
||||
slug: /specs/chats
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Files"
|
||||
slug: /specs/files
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: "Fine-tuning"
|
||||
slug: /specs/finetuning
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
Todo: @hiro
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Messages
|
||||
slug: /specs/messages
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Models
|
||||
slug: /specs/models
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Prompts
|
||||
slug: /specs/prompts
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
- [ ] /prompts folder
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Threads
|
||||
slug: /specs/threads
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: File-based Approach
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: Jan (Assistant)
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Jan: a "global" assistant
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Chat
|
||||
slug: /specs/chat
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Hub
|
||||
slug: /specs/hub
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Settings
|
||||
slug: /specs/settings
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
---
|
||||
title: System Monitor
|
||||
slug: /specs/system-monitor
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@ -1,5 +1,7 @@
|
||||
---
|
||||
title: User Interface
|
||||
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
|
||||
keywords: [Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee]
|
||||
---
|
||||
|
||||
:::warning
|
||||
|
||||
@ -38,6 +38,8 @@ const config = {
|
||||
mermaid: true,
|
||||
},
|
||||
|
||||
noIndex: false,
|
||||
|
||||
// Plugins we added
|
||||
plugins: [
|
||||
"docusaurus-plugin-sass",
|
||||
@ -140,15 +142,44 @@ const config = {
|
||||
metadata: [
|
||||
{ name: 'description', content: 'Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.' },
|
||||
{ name: 'keywords', content: 'Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee' },
|
||||
{ name: 'robots', content: 'index, follow' },
|
||||
{ property: 'og:title', content: 'Run your own AI | Jan' },
|
||||
{ property: 'og:description', content: 'Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.' },
|
||||
{ property: 'og:image', content: 'https://jan.ai/img/jan-social-card.png' },
|
||||
{ property: 'og:type', content: 'website' },
|
||||
{ property: 'twitter:card', content: 'summary_large_image' },
|
||||
{ property: 'twitter:site', content: '@janhq_' },
|
||||
{ property: 'twitter:title', content: 'Run your own AI | Jan' },
|
||||
{ property: 'twitter:description', content: 'Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.' },
|
||||
{ property: 'twitter:image', content: 'https://jan.ai/img/jan-social-card.png' },
|
||||
],
|
||||
headTags: [
|
||||
// Declare a <link> preconnect tag
|
||||
{
|
||||
tagName: 'link',
|
||||
attributes: {
|
||||
rel: 'preconnect',
|
||||
href: 'https://jan.ai/',
|
||||
},
|
||||
},
|
||||
// Declare some json-ld structured data
|
||||
{
|
||||
tagName: 'script',
|
||||
attributes: {
|
||||
type: 'application/ld+json',
|
||||
},
|
||||
innerHTML: JSON.stringify({
|
||||
'@context': 'https://schema.org/',
|
||||
'@type': 'localAI',
|
||||
name: 'Jan',
|
||||
description: "Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.",
|
||||
keywords: "Jan, ChatGPT alternative, on-premises AI, local API server, local AI, llm, conversational AI, no-subscription fee",
|
||||
applicationCategory: "BusinessApplication",
|
||||
operatingSystem: "Multiple",
|
||||
url: 'https://jan.ai/',
|
||||
}),
|
||||
},
|
||||
],
|
||||
navbar: {
|
||||
title: "Jan",
|
||||
logo: {
|
||||
|
||||
@ -19,7 +19,7 @@ export default function Home() {
|
||||
<AnnoncementBanner />
|
||||
<Layout
|
||||
title={`${siteConfig.tagline}`}
|
||||
description="Jan runs Large Language Models locally on Windows, Mac and Linux. Available on Desktop and Cloud-Native."
|
||||
description="Jan is a ChatGPT-alternative that runs on your own computer, with a local API server."
|
||||
>
|
||||
<main className="bg-gray-50 dark:bg-gray-950/95 relative">
|
||||
<div className="relative">
|
||||
|
||||
2
docs/static/robots.txt
vendored
Normal file
2
docs/static/robots.txt
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
User-Agent: *
|
||||
Allow: /
|
||||
@ -30,11 +30,11 @@
|
||||
"build:uikit": "yarn workspace @janhq/uikit install && yarn workspace @janhq/uikit build",
|
||||
"build:core": "cd core && yarn install && yarn run build",
|
||||
"build:web": "yarn workspace jan-web build && cpx \"web/out/**\" \"electron/renderer/\"",
|
||||
"build:electron": "yarn workspace jan build && cpx \"models/**\" \"electron/models/\"",
|
||||
"build:electron": "cpx \"models/**\" \"electron/models/\" && yarn workspace jan build",
|
||||
"build:electron:test": "yarn workspace jan build:test",
|
||||
"build:extensions": "rimraf ./electron/pre-install/*.tgz && concurrently --kill-others-on-fail \"cd ./extensions/conversational-extension && npm install && npm run build:publish\" \"cd ./extensions/inference-extension && npm install && npm run build:publish\" \"cd ./extensions/model-extension && npm install && npm run build:publish\" \"cd ./extensions/monitoring-extension && npm install && npm run build:publish\" \"cd ./extensions/assistant-extension && npm install && npm run build:publish\"",
|
||||
"build:test": "yarn build:web && yarn workspace jan build:test",
|
||||
"build": "yarn build:web && yarn workspace jan build",
|
||||
"build": "yarn build:web && yarn build:electron",
|
||||
"build:publish": "yarn build:web && yarn workspace jan build:publish"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user