Begin work on documentation

This commit is contained in:
David Payr
2025-03-29 11:47:21 +01:00
parent 95cc8beb06
commit 53e8ce5cac
9 changed files with 2704 additions and 4 deletions
+57
View File
@@ -0,0 +1,57 @@
import { defineConfig } from 'vitepress';
import footnote from 'markdown-it-footnote';
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'Mediakit',
description: 'A VitePress Site',
cleanUrls: true,
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/guide/introduction' },
],
sidebar: [
{
text: 'Getting started',
items: [
{ text: 'Introduction', link: '/guide/introduction' },
],
},
{
text: 'Reading media files',
items: [
{ text: 'Reading basics', link: '/guide/reading' },
{ text: 'Media sinks', link: '/guide/media-sinks' },
{ text: 'Input formats', link: '/guide/input-formats' },
],
},
{
text: 'Writing media files',
items: [
{ text: 'Writing basics', link: '/guide/writing' },
{ text: 'Media sources', link: '/guide/media-sources' },
{ text: 'Output formats', link: '/guide/output-formats' },
],
},
{
text: 'Miscellaneous',
items: [
{ text: 'Supported formats & codecs', link: 'guide/supported-formats-and-codecs' },
{ text: 'Custom coders', link: 'guide/custom-coders' },
],
},
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' },
],
},
markdown: {
config(md) {
md.use(footnote);
},
},
});