A fast, minimal, and Markdown-powered website for learning and documenting Data Structures, built using VitePress.
- 📝 Write and organize notes in Markdown
- ⚡️ Built with VitePress for speed and simplicity
- 📚 Structured content for Data Structures concepts
- 🧭 Configurable navigation and sidebar
- 💻 Easy local development and deployment
Vite-Notes/
├── docs/
│ ├── .vitepress/
│ │ └── config.mjs # Main VitePress configuration
│ ├── index.md # Home page
│ └── data-structures/ # Notes section
│ ├── index.md # Introduction to Data Structures
│ ├── arrays.md # Arrays concept
│ ├── linked-lists.md # Linked Lists concept
│ └── trees.md # Trees concept
├── package.json
└── README.md
# Clone this repository
git clone https://github.com/<your-username>/data-structures-notes.git
cd data-structures-notes
# Install dependencies
npm installTo start a local development server:
npm run docs:devOpen your browser and visit http://localhost:4000.
VitePress will automatically reload when you edit Markdown files.
npm run docs:buildThe static site will be generated in the .vitepress/dist folder.
To preview your built site locally:
npm run docs:previewThe sidebar and navigation are configured in:
docs/.vitepress/config.mjs
Example:
export default {
themeConfig: {
nav: [
{ text: "Home", link: "/" },
{ text: "Data Structures", link: "/data-structures/" },
],
sidebar: {
"/data-structures/": [
{
text: "Data Structures",
items: [
{ text: "Introduction", link: "/data-structures/" },
{ text: "Arrays", link: "/data-structures/arrays" },
{ text: "Linked Lists", link: "/data-structures/linked-lists" },
{ text: "Trees", link: "/data-structures/trees" },
],
},
],
},
},
};To add a new concept (e.g., Stacks):
-
Create a new Markdown file under
docs:docs/stacks.md
-
Add a sidebar entry in
config.mjs:{ text: 'Stacks', link: '/stacks' }
That’s it! The page will automatically appear in the sidebar and navigation.
VitePress generates a static site that can be deployed to any static host:
Example for GitHub Pages:
npm run docs:build
npx gh-pages -d docs/.vitepress/dist