feat: add documentation website (Docusaurus)
- 25 documentation pages covering Getting Started, User Guide, Developer Guide, and Reference - Docusaurus with custom amber/gold theme matching the landing page branding - GitHub Actions workflow to deploy landing page + docs to GitHub Pages - Landing page at root, docs at /docs/ on hermes-agent.nousresearch.com - Content extracted and restructured from existing repo docs (README, AGENTS.md, CONTRIBUTING.md, docs/) - Auto-deploy on push to main when website/ or landingpage/ changes
This commit is contained in:
parent
1708dcd2b2
commit
ada3713e77
45 changed files with 22822 additions and 0 deletions
120
website/docusaurus.config.ts
Normal file
120
website/docusaurus.config.ts
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
import {themes as prismThemes} from 'prism-react-renderer';
|
||||
import type {Config} from '@docusaurus/types';
|
||||
import type * as Preset from '@docusaurus/preset-classic';
|
||||
|
||||
const config: Config = {
|
||||
title: 'Hermes Agent',
|
||||
tagline: 'An AI agent that grows with you',
|
||||
favicon: 'img/favicon.svg',
|
||||
|
||||
url: 'https://hermes-agent.nousresearch.com',
|
||||
baseUrl: '/docs/',
|
||||
|
||||
organizationName: 'NousResearch',
|
||||
projectName: 'hermes-agent',
|
||||
|
||||
onBrokenLinks: 'warn',
|
||||
|
||||
markdown: {
|
||||
hooks: {
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
},
|
||||
},
|
||||
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en'],
|
||||
},
|
||||
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
{
|
||||
docs: {
|
||||
routeBasePath: '/', // Docs at the root of /docs/
|
||||
sidebarPath: './sidebars.ts',
|
||||
editUrl: 'https://github.com/NousResearch/hermes-agent/edit/main/website/',
|
||||
},
|
||||
blog: false,
|
||||
theme: {
|
||||
customCss: './src/css/custom.css',
|
||||
},
|
||||
} satisfies Preset.Options,
|
||||
],
|
||||
],
|
||||
|
||||
themeConfig: {
|
||||
image: 'img/hermes-agent-banner.png',
|
||||
colorMode: {
|
||||
defaultMode: 'dark',
|
||||
respectPrefersColorScheme: true,
|
||||
},
|
||||
navbar: {
|
||||
title: 'Hermes Agent',
|
||||
logo: {
|
||||
alt: 'Hermes Agent',
|
||||
src: 'img/favicon.svg',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'docs',
|
||||
position: 'left',
|
||||
label: 'Docs',
|
||||
},
|
||||
{
|
||||
href: 'https://hermes-agent.nousresearch.com',
|
||||
label: 'Home',
|
||||
position: 'right',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/NousResearch/hermes-agent',
|
||||
label: 'GitHub',
|
||||
position: 'right',
|
||||
},
|
||||
{
|
||||
href: 'https://discord.gg/NousResearch',
|
||||
label: 'Discord',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
items: [
|
||||
{ label: 'Getting Started', to: '/getting-started/installation' },
|
||||
{ label: 'User Guide', to: '/user-guide/cli' },
|
||||
{ label: 'Developer Guide', to: '/developer-guide/architecture' },
|
||||
{ label: 'Reference', to: '/reference/cli-commands' },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
{ label: 'Discord', href: 'https://discord.gg/NousResearch' },
|
||||
{ label: 'GitHub Discussions', href: 'https://github.com/NousResearch/hermes-agent/discussions' },
|
||||
{ label: 'Skills Hub', href: 'https://agentskills.io' },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'More',
|
||||
items: [
|
||||
{ label: 'GitHub', href: 'https://github.com/NousResearch/hermes-agent' },
|
||||
{ label: 'Nous Research', href: 'https://nousresearch.com' },
|
||||
],
|
||||
},
|
||||
],
|
||||
copyright: `Built by <a href="https://nousresearch.com">Nous Research</a> · MIT License · ${new Date().getFullYear()}`,
|
||||
},
|
||||
prism: {
|
||||
theme: prismThemes.github,
|
||||
darkTheme: prismThemes.dracula,
|
||||
additionalLanguages: ['bash', 'yaml', 'json', 'python', 'toml'],
|
||||
},
|
||||
} satisfies Preset.ThemeConfig,
|
||||
};
|
||||
|
||||
export default config;
|
||||
Loading…
Add table
Add a link
Reference in a new issue