From c70ec3553ddddd344e7cd76749706bf4bb678a4d Mon Sep 17 00:00:00 2001 From: Kacper Kula Date: Wed, 4 Jun 2025 17:16:56 +0200 Subject: [PATCH] docs: added documentation for charts (#165) --- .github/FUNDING.yml | 3 +- docs/.vitepress/config.mts | 32 +- docs/.vitepress/theme/components/Stats.vue | 8 +- docs/charts/advanced-mode.md | 4 + docs/charts/basics-pie.png | Bin 0 -> 41756 bytes docs/charts/basics.md | 39 + docs/charts/clustering.md | 147 ++ docs/charts/clustering.png | Bin 0 -> 46888 bytes docs/charts/introduction.md | 7 + docs/charts/regression.md | 96 ++ docs/charts/regression.png | Bin 0 -> 42847 bytes docs/charts/types/bar-chart-multi.png | Bin 0 -> 16705 bytes docs/charts/types/bar-chart.md | 65 + docs/charts/types/bar-chart.png | Bin 0 -> 14429 bytes docs/charts/types/candlestick.md | 26 + docs/charts/types/candlestick.png | Bin 0 -> 16453 bytes docs/charts/types/line-chart.md | 24 + docs/charts/types/line-chart.png | Bin 0 -> 29259 bytes docs/charts/types/mixed-chart.png | Bin 0 -> 51648 bytes docs/charts/types/mixed-charts.md | 76 + docs/charts/types/pie-chart-doughnut.png | Bin 0 -> 24736 bytes docs/charts/types/pie-chart-nightingale.png | Bin 0 -> 24980 bytes docs/charts/types/pie-chart.md | 59 + docs/charts/types/pie-chart.png | Bin 0 -> 24454 bytes docs/charts/types/radar.md | 38 + docs/charts/types/radar.png | Bin 0 -> 48518 bytes docs/charts/types/scatter-plot.md | 57 + docs/charts/types/scatter-plot.png | Bin 0 -> 19536 bytes package.json | 22 +- pnpm-lock.yaml | 1703 +++++++++---------- 30 files changed, 1445 insertions(+), 961 deletions(-) create mode 100644 docs/charts/advanced-mode.md create mode 100644 docs/charts/basics-pie.png create mode 100644 docs/charts/basics.md create mode 100644 docs/charts/clustering.md create mode 100644 docs/charts/clustering.png create mode 100644 docs/charts/introduction.md create mode 100644 docs/charts/regression.md create mode 100644 docs/charts/regression.png create mode 100644 docs/charts/types/bar-chart-multi.png create mode 100644 docs/charts/types/bar-chart.md create mode 100644 docs/charts/types/bar-chart.png create mode 100644 docs/charts/types/candlestick.md create mode 100644 docs/charts/types/candlestick.png create mode 100644 docs/charts/types/line-chart.md create mode 100644 docs/charts/types/line-chart.png create mode 100644 docs/charts/types/mixed-chart.png create mode 100644 docs/charts/types/mixed-charts.md create mode 100644 docs/charts/types/pie-chart-doughnut.png create mode 100644 docs/charts/types/pie-chart-nightingale.png create mode 100644 docs/charts/types/pie-chart.md create mode 100644 docs/charts/types/pie-chart.png create mode 100644 docs/charts/types/radar.md create mode 100644 docs/charts/types/radar.png create mode 100644 docs/charts/types/scatter-plot.md create mode 100644 docs/charts/types/scatter-plot.png diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 6679069..9f83236 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1,2 @@ -ko_fi: hypersphere \ No newline at end of file +ko_fi: hypersphere +patreon: hypersphere \ No newline at end of file diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 6615491..cb8772d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -24,6 +24,7 @@ export default defineConfig({ sidebar: [ { + collapsed: true, text: 'Documentation', items: [ { text: 'Quick Start', link: '/quick-start' }, @@ -45,6 +46,7 @@ export default defineConfig({ }, { text: 'Data Sources', + collapsed: true, items: [ { text: 'Vault Data', link: '/data-sources/vault-data' }, { text: 'CSV', link: '/data-sources/csv' }, @@ -54,6 +56,7 @@ export default defineConfig({ }, { text: 'Renderers', + collapsed: true, items: [ { text: 'Grid', link: '/renderers/grid' }, { text: 'HTML', link: '/renderers/html' }, @@ -62,8 +65,31 @@ export default defineConfig({ { text: 'Markdown', link: '/renderers/markdown' }, ] }, + { + text: 'Charts', + collapsed: true, + items: [ + { text: 'Charts introduction', link: '/charts/introduction' }, + { text: 'Basics', link: '/charts/basics' }, + { text: 'Chart Types', items: [ + { text: 'Bar Chart', link: '/charts/types/bar-chart', docFooterText: 'Chart Types: Bar Chart' }, + { text: 'Line Chart', link: '/charts/types/line-chart', docFooterText: 'Chart Types: Line Chart' }, + { text: 'Pie Chart', link: '/charts/types/pie-chart', docFooterText: 'Chart Types: Pie Chart' }, + { text: 'Scatter Plot', link: '/charts/types/scatter-plot', docFooterText: 'Chart Types: Scatter Plot' }, + { text: 'Candlestick', link: '/charts/types/candlestick', docFooterText: 'Chart Types: Candlestick' }, + { text: 'Radar', link: '/charts/types/radar', docFooterText: 'Chart Types: Radar' }, + { text: 'Sunburst', link: '/charts/types/sunburst', docFooterText: 'Chart Types: Sunburst' }, + { text: 'Mixed Charts', link: '/charts/types/mixed-charts' } + + ]}, + { text: 'Advanced Mode', link: '/charts/advanced-mode' }, + { text: 'Regression', link: '/charts/regression' }, + { text: 'Clustering', link: '/charts/clustering' } + ] + }, { text: 'FAQ', + collapsed: true, items: [ { text: 'Comparison with Dataview', link: '/faq/comparison-with-dataview' }, { text: 'SQLSeal with Obsidian Sync', link: '/faq/obsidian-sync' }, @@ -72,6 +98,7 @@ export default defineConfig({ ] }, { + collapsed: true, text: 'Contributing', items: [ { text: 'Contributing', link: '/contributing/get-started' }, @@ -89,7 +116,10 @@ export default defineConfig({ socialLinks: [ { icon: 'github', link: 'https://github.com/h-sphere/sql-seal' }, { icon: 'discord', link: 'https://discord.gg/ZMRnFeAWXb' }, - { icon: 'bluesky', link: 'https://bsky.app/profile/hypersphereblog.bsky.social' } + { icon: 'bluesky', link: 'https://bsky.app/profile/hypersphereblog.bsky.social' }, + { icon: 'kofi', link: 'https://ko-fi.com/hypersphere' }, + { icon: 'patreon', link: 'https://www.patreon.com/c/hypersphere' }, + ], footer: { message: '', diff --git a/docs/.vitepress/theme/components/Stats.vue b/docs/.vitepress/theme/components/Stats.vue index 692baa3..366fe3d 100644 --- a/docs/.vitepress/theme/components/Stats.vue +++ b/docs/.vitepress/theme/components/Stats.vue @@ -1,22 +1,22 @@