https://github.com/fokaaas/markdown-parser
This console application allows you to parse markdown into html
https://github.com/fokaaas/markdown-parser
console html markdown parser
Last synced: about 2 months ago
JSON representation
This console application allows you to parse markdown into html
- Host: GitHub
- URL: https://github.com/fokaaas/markdown-parser
- Owner: fokaaas
- Created: 2024-03-04T20:28:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T12:55:04.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T00:32:07.841Z (11 months ago)
- Topics: console, html, markdown, parser
- Language: TypeScript
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Parser
This console application allows you to parse markdown into html.
The result can be displayed in the console or saved to a file.
**Tech Stack**:
- Node.js
- TypeScript
- Commander
## How to set up it locally?
Firstly, clone this repo:
```bash
git clone https://github.com/fokaaas/markdown-parser.git
```
Then install **pnpm** globally:
```bash
npm install -g pnpm
```
Install dependencies in project directory:
```bash
pnpm install
```
Run application:
```bash
pnpm parse -o
```
Explore all commands:
```bash
pnpm parse --help
```
```bash
Usage: MD to HTML parser [options]
Converts a markdown file to HTML
Arguments:
path path to markdown file
Options:
-v, --version output the current version
-o, --out path to html file
-h, --help display help for command
```
## Example
Lets parse churka-example.md file and save result to churka-example.html:
### churka-example.md
```markdown
Їде `чурка` по дорозі. Зупиняється і **ба_чить**: _крисак на дорозі лежить_. Великий такий, правда дохлий.
Ну і вирішив він його забрати із собою. Взяв на руки, _відкрив багажник_. І положив туди крисака зі словами "Прігодіться!".
На наступний **день** їде чурка _тією самою_ дорогою. <Зупиняється>
Зупиняється>
\```
Відкриває `багажник, дістає звідти крисака`, кладе його на те
ж саме місце. І `говорить`: "Нє прігоділся!"
\```
```
Parse it:
```bash
pnpm parse churka-example.md -o churka-example.html
```
churka-example.html:
```html
Їде чурка по дорозі. Зупиняється і ба_чить: крисак на дорозі лежить. Великий такий, правда дохлий.
Ну і вирішив він його забрати із собою. Взяв на руки, відкрив багажник. І положив туди крисака зі словами "Прігодіться!".
На наступний день їде чурка тією самою дорогою. Зупиняється.
Відкриває `багажник, дістає звідти крисака`, кладе його на те
ж саме місце. І `говорить`: "Нє прігоділся!"
```
## Revert Commit
[Link](https://github.com/fokaaas/markdown-parser/commit/583d2de561e477b049711f8b901ca9fbfe9747cf)