Gist Blog Generator is a web application that simplifies the process of creating professionally formatted blog posts in Markdown, ready to be posted on GitHub Gists or other platforms that support Markdown.
- User-friendly interface for inputting blog post content
- Dynamic section addition for flexible blog structure
- Real-time Markdown preview
- Automatic generation of table of contents
- Support for author bio and social media links
- Responsive design for use on various devices
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js (v14.0.0 or later)
- npm (v6.0.0 or later)
-
Clone the repository
git clone https://github.com/yourusername/blog-markdown-generator.git
-
Navigate to the project directory
cd blog-markdown-generator
-
Install dependencies
npm install
-
Start the development server
npm run dev
-
Open your browser and visit
http://localhost:3000
- Fill in the blog post details in the provided form fields.
- Add or remove sections as needed using the "Add Section" button.
- Click "Generate Markdown" to create your formatted Markdown.
- View the generated Markdown in the "Preview" tab.
- Copy the generated Markdown and paste it into your GitHub Gist or preferred platform.
- Next.js - The React framework used
- React - JavaScript library for building user interfaces
- Tailwind CSS - A utility-first CSS framework
- shadcn/ui - Re-usable components built with Radix UI and Tailwind CSS
We welcome contributions to the Blog Markdown Generator! Please follow these steps to contribute:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
This project is licensed under the Apache License - see the LICENSE.md file for details.
- Thanks to the Next.js team for the amazing framework
- Inspiration from various Markdown editors and blog platforms
Arindam Hazra | XynoxTheDev - @XynoxTheDev - [email protected]
Project Link: XynoxTheDev/Gist-Blog-Generator