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

 
 
 

Contributors