Skip to content

Commit

Permalink
Change logo, remove docusaurus branding
Browse files Browse the repository at this point in the history
  • Loading branch information
t41372 committed Nov 10, 2024
1 parent bda930b commit 75c64a9
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 55 deletions.
2 changes: 1 addition & 1 deletion docs/Start/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you see this message, I'm currently reconstructing this documentation. Inform

# Introduction

Open-LLM-VTuber allows you to talk to (and interrupt!) any LLM locally by voice (hands-free) with a Live2D talking face. The LLM inference backend, speech recognition, and speech synthesizer are all designed to be swappable. This project can be configured to run offline on macOS, Linux, and Windows. Online LLM/ASR/TTS options are also supported.
[Open-LLM-VTuber](https://github.com/t41372/Open-LLM-VTuber) allows you to talk to (and interrupt!) any LLM locally by voice (hands-free) with a Live2D talking face. The LLM inference backend, speech recognition, and speech synthesizer are all designed to be swappable. This project can be configured to run offline on macOS, Linux, and Windows. Online LLM/ASR/TTS options are also supported.

Long-term memory with MemGPT can be configured to achieve perpetual chat, infinite* context length, and external data source.

Expand Down
64 changes: 27 additions & 37 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import {themes as prismThemes} from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Open-LLM-VTuber Docs',
tagline: 'Your AI girlfriend running locally across all platforms',
title: 'Open-LLM-VTuber',
tagline: 'Talk to LLMs with voice and Live2D avatar, locally across all platforms',
favicon: 'img/favicon.ico',

// Set the production url of your site here
Expand All @@ -21,7 +21,7 @@ const config = {
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 't41372', // Usually your GitHub org/user name.
projectName: 'Open-LLM-VTuber', // Usually your repo name.
projectName: 'Open-LLM-VTuber-Docs', // Usually your repo name.

onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
Expand All @@ -41,18 +41,10 @@ const config = {
({
docs: {
sidebarPath: './sidebars.js',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
'https://github.com/t41372/Open-LLM-VTuber-Docs/tree/main/',
},
blog: false,
theme: {
customCss: './src/css/custom.css',
},
Expand All @@ -63,24 +55,26 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
image: 'img/social-card.jpg',
navbar: {
title: 'My Site',
title: 'Open-LLM-VTuber',
logo: {
alt: 'My Site Logo',
src: 'img/logo.svg',
alt: 'Open-LLM-VTuber Logo',
src: 'img/logo.png',
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Docs',
label: 'Documentation',
},
{
type: 'localeDropdown',
position: 'right',
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/t41372/Open-LLM-VTuber',
label: 'GitHub',
position: 'right',
},
Expand All @@ -93,43 +87,39 @@ const config = {
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
label: 'Getting Started',
to: '/docs/Start/intro',
},
{
label: 'Installation Guide',
to: '/docs/Start/installation-guide',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
label: 'GitHub Discussions',
href: 'https://github.com/t41372/Open-LLM-VTuber/discussions',
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
label: 'Issues',
href: 'https://github.com/t41372/Open-LLM-VTuber/issues',
},
],
},
{
title: 'More',
items: [
{
label: 'Blog',
to: '/blog',
},
{
label: 'GitHub',
href: 'https://github.com/facebook/docusaurus',
href: 'https://github.com/t41372/Open-LLM-VTuber',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} Open-LLM-VTuber Docs. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
Expand Down
52 changes: 42 additions & 10 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,53 @@

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
label: 'Getting Started',
items: [
'Start/intro',
'Start/installation-guide',
'Start/Start',
],
},
{
type: 'category',
label: 'Features',
items: [
'features/llm-backends',
'features/live2d',
'features/translation',
],
},
{
type: 'category',
label: 'Speech Recognition',
items: [
'ASR/speech-recognition',
'ASR/Whisper',
'ASR/WhisperCPP',
'ASR/GroqWhisperASR',
'ASR/FunASR',
],
},
{
type: 'category',
label: 'Advanced',
items: [
'advanced/memgpt',
'advanced/mem0',
'advanced/docker',
],
},
{
type: 'category',
label: 'Development',
items: [
'development/contributing',
],
},
],
*/
};

export default sidebars;
12 changes: 5 additions & 7 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
to="/docs/Start/intro">
Get Started 🚀
</Link>
</div>
</div>
Expand All @@ -32,12 +32,10 @@ export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
title={`${siteConfig.title} - Voice Chat with Local LLMs`}
description="Talk to LLMs with voice and Live2D avatar, locally across all platforms">
<HomepageHeader />
<main>
<HomepageFeatures />
</main>

</Layout>
);
}
File renamed without changes

0 comments on commit 75c64a9

Please sign in to comment.