Skip to content

Latest commit

 

History

History
70 lines (57 loc) · 2.56 KB

README.md

File metadata and controls

70 lines (57 loc) · 2.56 KB

Gist Blog Generator

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.

Features

  • 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

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v14.0.0 or later)
  • npm (v6.0.0 or later)

Installation

  1. Clone the repository 
    git clone https://github.com/xynoxthedev/gist-blog-generator.git
  2. Navigate to the project directory 
    cd gist-blog-generator
  3. Install dependencies 
    npm install
  4. Start the development server 
    npm run dev
  5. Open your browser and visit http://localhost:3000

Usage

  1. Fill in the blog post details in the provided form fields.
  2. Add or remove sections as needed using the "Add Section" button.
  3. Click "Generate Markdown" to create your formatted Markdown.
  4. View the generated Markdown in the "Preview" tab.
  5. Copy the generated Markdown and paste it into your GitHub Gist or preferred platform.

Built With

  • 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

Contributing

We welcome contributions to the Blog Markdown Generator! Please follow these steps to contribute:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the Apache License - see the LICENSE.md file for details.

Acknowledgments

  • Thanks to the Next.js team for the amazing framework
  • Inspiration from various Markdown editors and blog platforms

Contact

Arindam Hazra | XynoxTheDev - @XynoxTheDev - connect@xynoxthedev.xyz