Merge branch 'main' into docs/assistants-api-reference

This commit is contained in:
Hieu 2023-12-04 10:16:17 +09:00 committed by GitHub
commit c4d78f7cc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 108 additions and 3 deletions

View File

@ -1,5 +1,7 @@
--- ---
title: About Jan 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. 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.

View File

@ -1,5 +1,7 @@
--- ---
title: Community 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 - [ ] Social media links

View File

@ -1,3 +1,5 @@
--- ---
title: Build an Assistant 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]
--- ---

View File

@ -1,5 +1,7 @@
--- ---
title: Extending Jan 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 ## Overview

View File

@ -1,3 +1,5 @@
--- ---
title: Model Management 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]
--- ---

View File

@ -1,3 +1,5 @@
--- ---
title: Build a Module 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]
--- ---

View File

@ -1,5 +1,7 @@
--- ---
title: API Server 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 :::warning

View File

@ -1,3 +1,5 @@
--- ---
title: Build a Theme 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]
--- ---

View File

@ -1,3 +1,5 @@
--- ---
title: Build a Tool 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]
--- ---

View File

@ -1,5 +1,7 @@
--- ---
title: Engineering 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 ## Connecting to Rigs

View File

@ -1,6 +1,8 @@
--- ---
title: Onboarding Checklist title: Onboarding Checklist
slug: /handbook 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 # Welcome

View File

@ -1,5 +1,7 @@
--- ---
title: Hardware Examples 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 ## Add your own example

View File

@ -1,5 +1,7 @@
--- ---
title: From Source 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 # Install Jan from Source

View File

@ -1,5 +1,7 @@
--- ---
title: Linux 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 # Installing Jan on Linux

View File

@ -1,5 +1,7 @@
--- ---
title: Mac 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 # Installing Jan on MacOS

View File

@ -1,5 +1,7 @@
--- ---
title: Overview 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. 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.

View File

@ -1,5 +1,7 @@
--- ---
title: Windows 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 # Installing Jan on Windows

View File

@ -1,5 +1,7 @@
--- ---
title: How Jan Works 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 - Local Filesystem

View File

@ -1,6 +1,8 @@
--- ---
title: Introduction title: Introduction
slug: /docs 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). Jan is a ChatGPT-alternative that runs on your own computer, with a [local API server](/api).

View File

@ -1,5 +1,7 @@
--- ---
title: Quickstart 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 - Write in the style of comics, explanation

View File

@ -1,6 +1,8 @@
--- ---
title: Architecture title: Architecture
slug: /specs 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 :::warning

View File

@ -1,6 +1,8 @@
--- ---
title: "Assistants" title: "Assistants"
slug: /specs/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 :::caution

View File

@ -1,6 +1,8 @@
--- ---
title: Chats title: Chats
slug: /specs/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 :::caution

View File

@ -1,6 +1,8 @@
--- ---
title: "Files" title: "Files"
slug: /specs/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 :::warning

View File

@ -1,6 +1,8 @@
--- ---
title: "Fine-tuning" title: "Fine-tuning"
slug: /specs/finetuning 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 Todo: @hiro

View File

@ -1,6 +1,8 @@
--- ---
title: Messages title: Messages
slug: /specs/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 :::caution

View File

@ -1,6 +1,8 @@
--- ---
title: Models title: Models
slug: /specs/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 :::caution

View File

@ -1,6 +1,8 @@
--- ---
title: Prompts title: Prompts
slug: /specs/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 - [ ] /prompts folder

View File

@ -1,6 +1,8 @@
--- ---
title: Threads title: Threads
slug: /specs/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 :::caution

View File

@ -1,5 +1,7 @@
--- ---
title: File-based Approach 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 :::warning

View File

@ -1,5 +1,7 @@
--- ---
title: Jan (Assistant) 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 ## Jan: a "global" assistant

View File

@ -1,6 +1,8 @@
--- ---
title: Chat title: Chat
slug: /specs/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 ## Overview

View File

@ -1,6 +1,8 @@
--- ---
title: Hub title: Hub
slug: /specs/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 ## Overview

View File

@ -1,6 +1,8 @@
--- ---
title: Settings title: Settings
slug: /specs/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 ## Overview

View File

@ -1,6 +1,8 @@
--- ---
title: System Monitor title: System Monitor
slug: /specs/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 ## Overview

View File

@ -1,5 +1,7 @@
--- ---
title: User Interface 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 :::warning

View File

@ -38,6 +38,8 @@ const config = {
mermaid: true, mermaid: true,
}, },
noIndex: false,
// Plugins we added // Plugins we added
plugins: [ plugins: [
"docusaurus-plugin-sass", "docusaurus-plugin-sass",
@ -140,15 +142,44 @@ const config = {
metadata: [ metadata: [
{ name: 'description', content: 'Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.' }, { 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: '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: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: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:image', content: 'https://jan.ai/img/jan-social-card.png' },
{ property: 'og:type', content: 'website' },
{ property: 'twitter:card', content: 'summary_large_image' }, { property: 'twitter:card', content: 'summary_large_image' },
{ property: 'twitter:site', content: '@janhq_' }, { property: 'twitter:site', content: '@janhq_' },
{ property: 'twitter:title', content: 'Run your own AI | Jan' }, { 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: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' }, { 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: { navbar: {
title: "Jan", title: "Jan",
logo: { logo: {

View File

@ -19,7 +19,7 @@ export default function Home() {
<AnnoncementBanner /> <AnnoncementBanner />
<Layout <Layout
title={`${siteConfig.tagline}`} 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"> <main className="bg-gray-50 dark:bg-gray-950/95 relative">
<div className="relative"> <div className="relative">

2
docs/static/robots.txt vendored Normal file
View File

@ -0,0 +1,2 @@
User-Agent: *
Allow: /

View File

@ -30,11 +30,11 @@
"build:uikit": "yarn workspace @janhq/uikit install && yarn workspace @janhq/uikit build", "build:uikit": "yarn workspace @janhq/uikit install && yarn workspace @janhq/uikit build",
"build:core": "cd core && yarn install && yarn run build", "build:core": "cd core && yarn install && yarn run build",
"build:web": "yarn workspace jan-web build && cpx \"web/out/**\" \"electron/renderer/\"", "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: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: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: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" "build:publish": "yarn build:web && yarn workspace jan build:publish"
}, },
"devDependencies": { "devDependencies": {