Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix/docusaurus-seo #818

Merged
merged 11 commits into from
Dec 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/about/about.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/community/community.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/docs/docs/assistants.md
Original file line number Diff line number Diff line change
@@ -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]
---
2 changes: 2 additions & 0 deletions docs/docs/docs/extensions.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/docs/models.md
Original file line number Diff line number Diff line change
@@ -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]
---
2 changes: 2 additions & 0 deletions docs/docs/docs/modules.md
Original file line number Diff line number Diff line change
@@ -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]
---
2 changes: 2 additions & 0 deletions docs/docs/docs/server.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/docs/themes.md
Original file line number Diff line number Diff line change
@@ -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]
---
2 changes: 2 additions & 0 deletions docs/docs/docs/tools.md
Original file line number Diff line number Diff line change
@@ -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]
---
2 changes: 2 additions & 0 deletions docs/docs/handbook/engineering/engineering.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/handbook/handbook.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/hardware/community.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/install/from-source.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/install/linux.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/install/mac.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/install/overview.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/install/windows.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/intro/how-jan-works.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/intro/introduction.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/intro/quickstart.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/architecture.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/assistants.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/chats.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/files.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/fine-tuning.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/messages.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/models.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/prompts.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/engineering/threads.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/file-based.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/jan.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/product/chat.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/product/hub.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/product/settings.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/product/system-monitor.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/specs/user-interface.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
31 changes: 31 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ const config = {
mermaid: true,
},

noIndex: false,

// Plugins we added
plugins: [
"docusaurus-plugin-sass",
Expand Down Expand Up @@ -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: {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
2 changes: 2 additions & 0 deletions docs/static/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
User-Agent: *
Allow: /