A markdown editor built with Node.js, Express, and Markdown-it. It allows users to write markdown text and see the rendered HTML output in real-time.
Make sure you have Node.js and npm installed on your system. If not, you can download and install them from here.
-
Clone the repository:
git clone https://github.com/LucasCur/MarkdownCanvas.git
-
Navigate into the project directory:
cd MarkdownCanvas -
Install dependencies using npm:
npm install
-
Start the server:
node index.js
By default, the server will run on port 3000. If port 3000 is already in use, the server will automatically choose another available port.
-
Open your web browser and go to
http://localhost:3000(or the dynamically chosen port if not 3000). -
You should see a textarea where you can input Markdown text. As you type, the rendered HTML output will appear below in real-time.
Contributions are more than welcome! If you would like to contribute to this project, please follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix:
git checkout -b feature-name
-
Make your changes and stage them for commit:
git add . -
Commit your changes:
git commit -m 'Added feature-name' -
Push to the branch:
git push origin feature-name
-
Submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.