From 5ecb0e780242cdda821e68d4a9de7c57fc6b4474 Mon Sep 17 00:00:00 2001 From: Amit Moryossef Date: Tue, 3 Dec 2024 18:08:52 +0100 Subject: [PATCH] docs(): expand, add blog section --- docs/.vitepress/config.mts | 79 ++++++++++++++++------- docs/blog/introduction/our-blog.md | 1 + docs/{ => docs}/facts/literacy.md | 0 docs/{ => docs}/facts/market.md | 0 docs/{ => docs}/facts/numbers.md | 0 docs/docs/introduction/getting-started.md | 1 + docs/index.md | 8 +-- 7 files changed, 63 insertions(+), 26 deletions(-) create mode 100644 docs/blog/introduction/our-blog.md rename docs/{ => docs}/facts/literacy.md (100%) rename docs/{ => docs}/facts/market.md (100%) rename docs/{ => docs}/facts/numbers.md (100%) create mode 100644 docs/docs/introduction/getting-started.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 44445504..be12b4cf 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -8,6 +8,10 @@ export default withMermaid( title: 'Documentation', description: 'sign.mt Documentation and Blog', base: '/docs/', + lastUpdated: true, + sitemap: { + hostname: 'https://sign.mt/docs/', + }, themeConfig: { search: { provider: 'local', @@ -20,29 +24,60 @@ export default withMermaid( dark: '/logo-dark.svg', alt: 'sign.mt Logo', }, - sidebar: [ - { - text: 'Fact Sheets', - items: [ - { - text: 'Numbers', - link: '/facts/numbers', - items: [ - {text: 'Hearing Loss', link: '/facts/numbers#hearing-loss'}, - {text: 'Deafness', link: '/facts/numbers#deafness'}, - ], - }, - { - text: 'Literacy', - link: '/facts/literacy', - items: [ - {text: 'Challenges', link: '/facts/literacy#challenges-and-causes'}, - {text: 'Statistics', link: '/facts/literacy#statistics'}, - ], - }, - ], - }, + nav: [ + {text: 'Docs', link: '/docs/introduction/getting-started'}, + {text: 'Blog', link: '/blog/introduction/our-blog'}, ], + sidebar: { + '/blog/': [ + { + text: 'Introduction', + items: [ + { + text: 'Our Blog', + link: '/blog/introduction/our-blog', + }, + ], + }, + ], + '/docs/': [ + { + text: 'Introduction', + items: [ + { + text: 'Getting Started', + link: '/docs/introduction/getting-started', + }, + ], + }, + { + text: 'Fact Sheets', + collapsed: false, + items: [ + { + text: 'Numbers', + link: '/docs/facts/numbers', + items: [ + {text: 'Hearing Loss', link: '/docs/facts/numbers#hearing-loss'}, + {text: 'Deafness', link: '/docs/facts/numbers#deafness'}, + ], + }, + { + text: 'Literacy', + link: '/docs/facts/literacy', + items: [ + {text: 'Challenges', link: '/docs/facts/literacy#challenges-and-causes'}, + {text: 'Statistics', link: '/docs/facts/literacy#statistics'}, + ], + }, + { + text: 'Market', + link: '/docs/facts/market', + }, + ], + }, + ], + }, socialLinks: [ {icon: 'github', link: 'https://github.com/sign/translate'}, diff --git a/docs/blog/introduction/our-blog.md b/docs/blog/introduction/our-blog.md new file mode 100644 index 00000000..b1385f9a --- /dev/null +++ b/docs/blog/introduction/our-blog.md @@ -0,0 +1 @@ +# Blog! diff --git a/docs/facts/literacy.md b/docs/docs/facts/literacy.md similarity index 100% rename from docs/facts/literacy.md rename to docs/docs/facts/literacy.md diff --git a/docs/facts/market.md b/docs/docs/facts/market.md similarity index 100% rename from docs/facts/market.md rename to docs/docs/facts/market.md diff --git a/docs/facts/numbers.md b/docs/docs/facts/numbers.md similarity index 100% rename from docs/facts/numbers.md rename to docs/docs/facts/numbers.md diff --git a/docs/docs/introduction/getting-started.md b/docs/docs/introduction/getting-started.md new file mode 100644 index 00000000..bad55622 --- /dev/null +++ b/docs/docs/introduction/getting-started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/index.md b/docs/index.md index aabefa7d..bf836011 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,11 +8,11 @@ hero: tagline: 'A collection of resources on sign languages, deaf culture, and our technology.' actions: - theme: brand - text: Numbers - link: /facts/numbers + text: Docs + link: /docs/introduction/getting-started - theme: alt - text: literacy - link: /facts/literacy + text: Blog + link: /blog/introduction/our-blog #features: # - title: Feature A # details: Lorem ipsum dolor sit amet, consectetur adipiscing elit