markdown-ts-compiler: A TypeScript repository from meugenom

                        _       _
   _ __ ___   __ _ _ __| | ____| | _____      ___ __  
  | '_ ` _ \ / _` | '__| |/ / _` |/ _ \ \ /\ / / '_ \ 
  | | | | | | (_| | |  |   < (_| | (_) \ V  V /| | | |
  |_| |_| |_|\__,_|_|  |_|\_\__,_|\___/ \_/\_/ |_| |_|

                                  _ _       
         ___ ___  _ __ ___  _ __ (_) | ___ _ __ 
        / __/ _ \| '_ ` _ \| '_ \| | |/ _ \ '__|
       | (_| (_) | | | | | | |_) | | |  __/ |
        \___\___/|_| |_| |_| .__/|_|_|\___|_|
                           |_|

Markdown Typescript Compiler

Purpose:

I created this parser to serve as a compiler for my personal website, specifically for parsing Markdown text into HTML. I utilized TypeScript and Webpack in the development process, and the styling is enhanced with Tailwind CSS. You can view the result on my website: Markdown TS Compiler, where there's a parsed example page.

Important: To display the result, the script constructs the DOM model in the browser; a virtual DOM model is not utilized. This functionality might be considered in the next version.

Technologies Used:

npm v9.7.2, node v16.14.2
Typescript v5.3.2
Webpack v5.4.1
TS-Loader v9.5.1
Tailwind CSS from website v3.3.5
Prism.js from website for code highlighting v1.29.0

How to use it:

Clone the repository:
Install the dependencies:
```
npm install
```
Run the compiler:
```
npm run build
```
Open in your browser the address: http://localhost:8083
For testing use command:
```
npm run test
```

API Reference:

Please see entrypoint ./src/index.ts for the API reference.

API functions:

convertMDtoHTML(txt: string) - converts markdown text into HTML, return HTML string
convertMDtoTokens(txt: string) - converts markdown text into tokens, return array of tokens
convertMDtoAST(txt: string) - converts markdown text into AST, return Abstract Syntax Tree

How to use it in your project:

Directories:

./src - the main compiler code:
- ../test - the test code
- ../htmlblocks - the html blocks to parse AST into HTML
- ../content - the example text to parse
- ../static - the static files index.html, css styles
- ../types - integration with external libraries
/dist - the compiled code and static files, need to run build command‚

Files:

./src/index.ts - the entrypoint of the comiler
./src/Grammar.ts - the grammar with Regexp rules
./src/Tokenizer.ts - the tokenize class to make tokens from a text
./src/Parser.ts - the parser class to parse tokens into AST
./src/View.ts - the compiler class to compile AST into HTML

You can use and modify this code as you want. Just clone it and use it.

The main compiler code is located in the directory "./src". You can copy it to your project and use it as library.

For you project please install the required dependencies:

npm install --save-dev @types/prismjs css-loader html-loader postcss postcss-import postcss-loader postcss-preset-env prismjs raw-loader style-loader tailwindcss ts-loader typescript uuid

Please copy tailwind.config.js and postcss.config.js to your project.

Author:

meugenom