Skip to content

πŸ’‘ Instantly Generate Custom GitHub Guides in PDF Format πŸ“˜ Great for team onboarding, tutorials, or brushing up on Git! ➑️ Live demo available – try it now! πŸ§ͺ✨No clutter. Just clean, personalized documentation. πŸ’Όβœ¨

License

Notifications You must be signed in to change notification settings

AlokKumarYadav2410/git-pdf-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“„ Git-PDF-Generator : Personalized GitHub Guides as PDFs πŸš€

Welcome to GitPDF! πŸŽ‰ GitPDF is a unique tool that generates personalized PDF guides for GitHub commands and workflows. Whether you're onboarding a new team member, teaching GitHub basics, or creating a custom guide for yourself, GitPDF makes it simple and efficient! πŸ’Όβœ¨

πŸ“š Table of Contents

🎨 Screenshots

Home Page

githubuser

🌐 Live Demo

Check out the live demo here: πŸ”— Git-PDf-Generator Live Demo 🌍

🌟 Features

  • ✨ Personalized PDFs: Generate GitHub guides with the user's name for a personal touch.
  • πŸ“„ Comprehensive GitHub Commands: Includes essential GitHub commands and workflows.
  • 🎨 Customizable Themes: Choose between light and dark themes for your PDF.
  • ⚑ Fast and Lightweight: Built with modern tools for quick and seamless performance.
  • πŸ”— Shareable PDFs: Easily share the generated PDFs with others.

πŸ–₯️ Tech Stack

  • Frontend: React βš›οΈ
  • Build Tool: Vite ⚑
  • Styling: TailwindCSS 🎨
  • PDF Generation: jsPDF πŸ“„
  • Icons: React Icons πŸš€

πŸš€ Getting Started

Follow these steps to run Git-PDF-Generator on your local machine:

1️⃣ Clone the Repository

git clone https://github.com/AlokKumarYadav2410/git-pdf-generator.git

cd git-pdf-generator

2️⃣ Install Dependencies

npm install

3️⃣ Install Tailwind CSS

npm install tailwindcss @tailwindcss/vite

4️⃣ React PDF

npm install @react-pdf/renderer

5️⃣ Toast Notifications

npm install react-hot-toast

6️⃣ Icons

npm install react-icons

7️⃣ Start the Development Server

npm run dev

8️⃣ Open in Browser

Visit http://localhost:5173 to see GitPDF in action! πŸŽ‰
or
http://localhost:5174

πŸ“‚ Project Structure

git-pdf-generator/
β”œβ”€β”€ public/               # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/       # Reusable components (Footer, Header, etc.)
β”‚   β”œβ”€β”€ App.jsx           # Main application file
β”‚   β”œβ”€β”€ index.css         # Global styles
β”‚   └── main.jsx          # Entry point
β”œβ”€β”€ package.json          # Project dependencies and scripts
└── README.md             # Project documentation

🀝 Contributing

We welcome contributions! πŸ› οΈ If you'd like to improve GitPDF, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Make your changes and commit them: git commit -m "Add feature-name".
  4. Push to your branch: git push origin feature-name.
  5. Open a pull request.

πŸ“œ License

  • This project is licensed under the MIT License. See the LICENSE file for details.

❀️ Acknowledgments

  • Built with love by Alok Kumar Yadav.
  • Inspired by the need for simple and effective task management.

🌐 Connect with Me


GitPDF: Simplify GitHub learning with personalized guides! ✨

About

πŸ’‘ Instantly Generate Custom GitHub Guides in PDF Format πŸ“˜ Great for team onboarding, tutorials, or brushing up on Git! ➑️ Live demo available – try it now! πŸ§ͺ✨No clutter. Just clean, personalized documentation. πŸ’Όβœ¨

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published