This program was created by Maksym Sachko, group IM-22, FICE, KPI. This is a simple text converter from Markdown text to HTML text. The program can convert some Markdown tags to HTML tags, such as bold, italic, monospaced, preformat, and paragraph tags. It can also detect invalid markup and find nested tags, save the output data to a .html file, or output that data to stdout.
NOTE: Markdown-to-HTML convertor is made with node.js you need install Node.js to run the program
-
You need to clone this repository from GitHub before running the program. Select the folder you want to clone the repository to, then type the command:
git clone https://github.com/SachkoMaxim/Methodologies-lab.git -
Then navigate to the cloned repository folder:
cd ../Methodologies-lab -
Run main.js file:
node main.js <file.md>
Markdown-to-HTML convertor has two modes: console mode and file mode.
NOTE: Only Markdown files can be used as an input file for the program. If you use other file types, you will see an ERROR
To run the program in the console mode, just type this command in your terminal in the project folder (don't forget to pass the input file path into the arguments of the command):
node main.js </path/to/markdown.md>
After that, the converted text with HTML tags will be displayed in stdout (if there was no mistakes, of course).
To run the program in the file mode, you need to add --out and pass the output file path into the arguments of the previous command:
NOTE: if you didn't write --out the converted text with HTML tags will be redirected to stdout
NOTE: Only HTML files can be used as an output file for the program. If you use other file types, you will see an ERROR
node main.js </path/to/markdown.md> --out </path/to/file.html>
After that, the converted text with HTML tags will be saved to a .html file you choosed as an output file (if there was no mistakes, of course).
There are six example files in the examples folder for you to comfortably test the program.