Skip to content

A lightweight JavaScript Markdown to HTML converter based on showdown.

License

Notifications You must be signed in to change notification settings

VladimirV99/Markdown

Repository files navigation

Markdown

A lightweight JavaScript Markdown to HTML converter based on showdown. It includes a GitHub-like markdown editor for easier styling and previewing the HTML.

Required software

NodeJS and npm are required for building and testing the project

Building the project

Clone the repository and navigate into it

git clone https://github.com/VladimirV99/Markdown.git
cd Markdown

Then install the dependencies and run the build script

npm install
npm run build

That will generate and test the browser and node versions of the library in the build directory. They will be named markdown.js and markdown.node.js respectively.

Testing

There are tests for almost every supported markdown rule. Once the dependencies are installed, they can be run using

npm test

License

The project is licensed under the MIT license. That means you are free to modify and distribute the software for commercial purposes (even under different terms or without source code) or use is privately. The only condition is that a copy of the license must be included with the software.

Contributing

Feel free to contribute to the project either by submitting issues or making pull requests.

Thank you for the help 😊

About

A lightweight JavaScript Markdown to HTML converter based on showdown.

Resources

License

Stars

Watchers

Forks