Skip to content

nitinawari/DevNotes

Repository files navigation

📒 DevNotes

DevNotes is a personal developer wiki built with Docusaurus — designed to organize technical notes, cheat sheets, mind maps, and resources in one searchable, version-controlled space.


✨ Features

  • 🖥 Custom UI — Tailored theme for better readability.
  • 🔍 Full-text Search — Local search with Algolia planned for future.
  • 🗂 Category-based Navigation — Organize notes by topic.
  • GitHub Pages Deployment — Automatic CI/CD publishing.
  • 📄 Markdown Powered — Simple writing format.
  • 📚 Multi-topic Coverage — Programming, DevOps, Linux, and more.

📂 Folder Structure

DevNotes/
├── docs/                  # Main documentation content
├── blog/                  # Blog posts (optional)
├── sidebars.ts            # Sidebar configuration
├── docusaurus.config.ts   # Site configuration
├── src/                   # Custom components & styles
└── static/                # Static assets (images, icons, etc.)

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/nitinawari/DevNotes.git
cd DevNotes

2. Install Dependencies

npm install

3. Start Development Server

npm run start

4. Build for Production

npm run build

🌐 Deployment

This project is automatically deployed to GitHub Pages using GitHub Actions.

To deploy manually:

GIT_USER=<YourGitHubUsername> npm run deploy

About

DevNotes – Documenting Every Step of the Developer Journey.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published