Skip to content

Latest commit

 

History

29 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 Vite Notes

A fast, minimal, and Markdown-powered website for learning and documenting Data Structures, built using VitePress.

🚀 Features

  • 📝 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

📂 Project Structure

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

⚙️ Installation

# Clone this repository
git clone https://github.com/<your-username>/data-structures-notes.git

cd data-structures-notes

# Install dependencies
npm install

🧩 Development

To start a local development server:

npm run docs:dev

Open your browser and visit http://localhost:4000.

VitePress will automatically reload when you edit Markdown files.

🏗️ Build for Production

npm run docs:build

The static site will be generated in the .vitepress/dist folder.

To preview your built site locally:

npm run docs:preview

🧭 Navigation Setup

The 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" },
          ],
        },
      ],
    },
  },
};

🧱 Add New Topics

To add a new concept (e.g., Stacks):

  1. Create a new Markdown file under docs:

    docs/stacks.md
  2. Add a sidebar entry in config.mjs:

    { text: 'Stacks', link: '/stacks' }

That’s it! The page will automatically appear in the sidebar and navigation.

🌐 Deployment

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

About

A website for creating and organizing notes, built with VitePress.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors