Skip to content

Commit

Permalink
docs(homepage): introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
serjilyashenko committed Aug 28, 2024
1 parent 40309e6 commit d0f6e45
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
8 changes: 7 additions & 1 deletion apps/homepage/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,15 @@ export default defineConfig({
},
sidebar: [
{
label: "Guides",
label: "Getting Started",
items: [
// Each item here is one entry in the navigation menu.
{ label: "Introduction", slug: "getting-started/introduction" }
]
},
{
label: "Guides",
items: [
{ label: "Example Guide", slug: "guides/example" }
]
},
Expand Down
27 changes: 27 additions & 0 deletions apps/homepage/src/content/docs/getting-started/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Introduction
description: A guide in my new Starlight docs site.
---

The simple-pie package family offers an easy way to create SVG pie and doughnut charts. These packages are lightweight
and ideal for situations where you need small, simple charts, such as in network graphs or other compact visualizations.

| package | size |
|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [simple-pie](https://www.npmjs.com/package/simple-pie) | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/simple-pie) ![npm bundle size](https://img.shields.io/bundlephobia/min/simple-pie) |
| [react-simple-pie](https://www.npmjs.com/package/react-simple-pie) | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-simple-pie) ![npm bundle size](https://img.shields.io/bundlephobia/min/react-simple-pie) |

## Motivation

The idea for the simple-pie packages came from a need to add small pie charts to a network graph. The network graph
library only supported PNG or SVG files for node content, making it impractical to store many pre-rendered images for
different data sets.

Using popular charting libraries like Highcharts or Chart.js wasn't an option because they were too complex for this
specific use case. Even though D3.js might have worked, it was still too large for such a simple need.

That's where simple-pie comes in. It provides a straightforward solution for creating the smallest possible SVG pie and
doughnut charts. These charts are perfect for embedding in network graphs, maps, or any application where you need
a simple and efficient way to visualize data without the bulk of heavier libraries.

![net and map cases](https://raw.githubusercontent.com/serjilyashenko/simple-pie-project/master/docs/images/map-and-net-case.png)

0 comments on commit d0f6e45

Please sign in to comment.