Add documentation website (#833)

* test frontmatter rendering

* restructure files

* add docs website

* move postcss config

* revert postcss config

* update readme

* update logo

* fix internal links
This commit is contained in:
Sascha Ißbrücker
2024-09-17 15:33:53 +02:00
committed by GitHub
parent 53e4aeb1c1
commit 0e488b7ce3
37 changed files with 8153 additions and 248 deletions

50
docs/astro.config.mjs Normal file
View File

@@ -0,0 +1,50 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'linkding',
logo: {
src: './src/assets/logo.svg',
},
social: {
github: 'https://github.com/sissbruecker/linkding',
},
sidebar: [
{
label: 'Getting Started',
items: [
{ label: 'Installation', slug: 'installation' },
{ label: 'Managed Hosting', slug: 'managed-hosting' },
{ label: 'Browser Extension', slug: 'browser-extension' },
],
},
{
label: 'Guides',
items: [
{ label: 'Options', slug: 'options' },
{ label: 'Backups', slug: 'backups' },
{ label: 'Admin', slug: 'admin' },
{ label: 'Keyboard Shortcuts', slug: 'shortcuts' },
{ label: 'How To', slug: 'how-to' },
{ label: 'Troubleshooting', slug: 'troubleshooting' },
{ label: 'REST API', slug: 'api' },
],
},
{
label: 'Resources',
items: [
{ label: 'Community', slug: 'community' },
{ label: 'Acknowledgements', slug: 'acknowledgements' },
],
},
],
customCss: [
'./src/styles/custom.css',
],
}),
],
});