Getting Started

Welcome to Markdown Maestro! This guide will walk you through the first steps to get the editor up and running on your local machine.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (version 18 or newer)
  • npm, yarn, or pnpm as your package manager.

Installation

Getting your own instance of Markdown Maestro running is simple. Just follow these steps in your terminal.

1. First, clone the repository from GitHub:

git clone https://github.com/your-username/markdown-maestro.git

2. Next, navigate into the newly created project directory:

cd markdown-maestro

3. Install all the required dependencies using npm:

npm install

4. Once the installation is complete, you can start the development server:

npm run dev

And that's it! Your application should now be running. You can view it by opening your web browser and navigating to http://localhost:9002.

Next Steps

Now that you have the project running, here are a few things you can do:

  • Visit the Demo page to try out the live editor.
  • Explore the Features page to see what Markdown Maestro can do.
  • Read our Contribution Guide if you're interested in helping improve the project.