diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md index 4a82d93d6..5fabb707e 100644 --- a/docs/docs/about/about.md +++ b/docs/docs/about/about.md @@ -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. diff --git a/docs/docs/community/community.md b/docs/docs/community/community.md index d6807f38a..623cea8e8 100644 --- a/docs/docs/community/community.md +++ b/docs/docs/community/community.md @@ -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 \ No newline at end of file diff --git a/docs/docs/docs/assistants.md b/docs/docs/docs/assistants.md index 0edc163ba..2f4b1f99f 100644 --- a/docs/docs/docs/assistants.md +++ b/docs/docs/docs/assistants.md @@ -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] --- \ No newline at end of file diff --git a/docs/docs/docs/extensions.md b/docs/docs/docs/extensions.md index 87edbf863..56cfdfe51 100644 --- a/docs/docs/docs/extensions.md +++ b/docs/docs/docs/extensions.md @@ -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 diff --git a/docs/docs/docs/models.md b/docs/docs/docs/models.md index 9e929b76b..4e123e746 100644 --- a/docs/docs/docs/models.md +++ b/docs/docs/docs/models.md @@ -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] --- \ No newline at end of file diff --git a/docs/docs/docs/modules.md b/docs/docs/docs/modules.md index 41a112417..cb7888f67 100644 --- a/docs/docs/docs/modules.md +++ b/docs/docs/docs/modules.md @@ -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] --- \ No newline at end of file diff --git a/docs/docs/docs/server.md b/docs/docs/docs/server.md index 05a715932..d309d8817 100644 --- a/docs/docs/docs/server.md +++ b/docs/docs/docs/server.md @@ -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 diff --git a/docs/docs/docs/themes.md b/docs/docs/docs/themes.md index 2d07b30e1..3edfaf490 100644 --- a/docs/docs/docs/themes.md +++ b/docs/docs/docs/themes.md @@ -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] --- \ No newline at end of file diff --git a/docs/docs/docs/tools.md b/docs/docs/docs/tools.md index 3c6c721e4..d8dd132a8 100644 --- a/docs/docs/docs/tools.md +++ b/docs/docs/docs/tools.md @@ -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] --- \ No newline at end of file diff --git a/docs/docs/handbook/engineering/engineering.md b/docs/docs/handbook/engineering/engineering.md index e320b25fe..3ca9952c4 100644 --- a/docs/docs/handbook/engineering/engineering.md +++ b/docs/docs/handbook/engineering/engineering.md @@ -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 diff --git a/docs/docs/handbook/handbook.md b/docs/docs/handbook/handbook.md index 674b96c76..a0485da61 100644 --- a/docs/docs/handbook/handbook.md +++ b/docs/docs/handbook/handbook.md @@ -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 diff --git a/docs/docs/hardware/community.md b/docs/docs/hardware/community.md index 5d9bfcc16..a8c3ffee9 100644 --- a/docs/docs/hardware/community.md +++ b/docs/docs/hardware/community.md @@ -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 diff --git a/docs/docs/install/from-source.md b/docs/docs/install/from-source.md index 961e7fc85..5377e831c 100644 --- a/docs/docs/install/from-source.md +++ b/docs/docs/install/from-source.md @@ -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 diff --git a/docs/docs/install/linux.md b/docs/docs/install/linux.md index a7af581c4..0b61f96d8 100644 --- a/docs/docs/install/linux.md +++ b/docs/docs/install/linux.md @@ -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 diff --git a/docs/docs/install/mac.md b/docs/docs/install/mac.md index 21ecdb54c..a618d05e3 100644 --- a/docs/docs/install/mac.md +++ b/docs/docs/install/mac.md @@ -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 diff --git a/docs/docs/install/overview.md b/docs/docs/install/overview.md index 067eb55f2..b41db64d7 100644 --- a/docs/docs/install/overview.md +++ b/docs/docs/install/overview.md @@ -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. diff --git a/docs/docs/install/windows.md b/docs/docs/install/windows.md index ecf57f51f..f3de435ec 100644 --- a/docs/docs/install/windows.md +++ b/docs/docs/install/windows.md @@ -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 diff --git a/docs/docs/intro/how-jan-works.md b/docs/docs/intro/how-jan-works.md index fdfd12a10..b8202224d 100644 --- a/docs/docs/intro/how-jan-works.md +++ b/docs/docs/intro/how-jan-works.md @@ -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 diff --git a/docs/docs/intro/introduction.md b/docs/docs/intro/introduction.md index a483b10cc..1501cfc4b 100644 --- a/docs/docs/intro/introduction.md +++ b/docs/docs/intro/introduction.md @@ -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). diff --git a/docs/docs/intro/quickstart.md b/docs/docs/intro/quickstart.md index e417838ea..606003be1 100644 --- a/docs/docs/intro/quickstart.md +++ b/docs/docs/intro/quickstart.md @@ -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 diff --git a/docs/docs/specs/architecture.md b/docs/docs/specs/architecture.md index 39b7fa833..2557f6203 100644 --- a/docs/docs/specs/architecture.md +++ b/docs/docs/specs/architecture.md @@ -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 diff --git a/docs/docs/specs/engineering/assistants.md b/docs/docs/specs/engineering/assistants.md index d03989d66..eb340ae1f 100644 --- a/docs/docs/specs/engineering/assistants.md +++ b/docs/docs/specs/engineering/assistants.md @@ -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 diff --git a/docs/docs/specs/engineering/chats.md b/docs/docs/specs/engineering/chats.md index 7bb96faf0..7daac57b0 100644 --- a/docs/docs/specs/engineering/chats.md +++ b/docs/docs/specs/engineering/chats.md @@ -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 diff --git a/docs/docs/specs/engineering/files.md b/docs/docs/specs/engineering/files.md index 0becbf6d6..b93054ef1 100644 --- a/docs/docs/specs/engineering/files.md +++ b/docs/docs/specs/engineering/files.md @@ -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 diff --git a/docs/docs/specs/engineering/fine-tuning.md b/docs/docs/specs/engineering/fine-tuning.md index f2d4153d2..97c45d85b 100644 --- a/docs/docs/specs/engineering/fine-tuning.md +++ b/docs/docs/specs/engineering/fine-tuning.md @@ -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 diff --git a/docs/docs/specs/engineering/messages.md b/docs/docs/specs/engineering/messages.md index 62a721fa8..4032e61d4 100644 --- a/docs/docs/specs/engineering/messages.md +++ b/docs/docs/specs/engineering/messages.md @@ -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 diff --git a/docs/docs/specs/engineering/models.md b/docs/docs/specs/engineering/models.md index c47a62bab..decf8f5e9 100644 --- a/docs/docs/specs/engineering/models.md +++ b/docs/docs/specs/engineering/models.md @@ -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 diff --git a/docs/docs/specs/engineering/prompts.md b/docs/docs/specs/engineering/prompts.md index 37422b517..9d4fa4fd6 100644 --- a/docs/docs/specs/engineering/prompts.md +++ b/docs/docs/specs/engineering/prompts.md @@ -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 diff --git a/docs/docs/specs/engineering/threads.md b/docs/docs/specs/engineering/threads.md index 982c4f8cb..c1421e4ae 100644 --- a/docs/docs/specs/engineering/threads.md +++ b/docs/docs/specs/engineering/threads.md @@ -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 diff --git a/docs/docs/specs/file-based.md b/docs/docs/specs/file-based.md index 3b38bb06b..26f3d8efb 100644 --- a/docs/docs/specs/file-based.md +++ b/docs/docs/specs/file-based.md @@ -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 diff --git a/docs/docs/specs/jan.md b/docs/docs/specs/jan.md index 9a97c29c2..e92dddf7a 100644 --- a/docs/docs/specs/jan.md +++ b/docs/docs/specs/jan.md @@ -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 diff --git a/docs/docs/specs/product/chat.md b/docs/docs/specs/product/chat.md index 28969f348..acbf57487 100644 --- a/docs/docs/specs/product/chat.md +++ b/docs/docs/specs/product/chat.md @@ -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 diff --git a/docs/docs/specs/product/hub.md b/docs/docs/specs/product/hub.md index c2523b0fb..1a9f6064a 100644 --- a/docs/docs/specs/product/hub.md +++ b/docs/docs/specs/product/hub.md @@ -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 diff --git a/docs/docs/specs/product/settings.md b/docs/docs/specs/product/settings.md index a80c50034..d7e60e943 100644 --- a/docs/docs/specs/product/settings.md +++ b/docs/docs/specs/product/settings.md @@ -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 diff --git a/docs/docs/specs/product/system-monitor.md b/docs/docs/specs/product/system-monitor.md index 52d11a272..f4c77c38c 100644 --- a/docs/docs/specs/product/system-monitor.md +++ b/docs/docs/specs/product/system-monitor.md @@ -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 diff --git a/docs/docs/specs/user-interface.md b/docs/docs/specs/user-interface.md index c540a6973..156eac5a6 100644 --- a/docs/docs/specs/user-interface.md +++ b/docs/docs/specs/user-interface.md @@ -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 diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 7b07016d2..da62e3399 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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 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: { diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index d87e00498..986fff9a2 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -19,7 +19,7 @@ export default function Home() {
diff --git a/docs/static/robots.txt b/docs/static/robots.txt new file mode 100644 index 000000000..f6e6d1d41 --- /dev/null +++ b/docs/static/robots.txt @@ -0,0 +1,2 @@ +User-Agent: * +Allow: / diff --git a/package.json b/package.json index 9192a0238..c2754d3ad 100644 --- a/package.json +++ b/package.json @@ -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": {