zPatronus's blog

Markdown to HTML Convertor

Posted on Edited on
A program that converts markdown to HTML

For users

The convertor currently supports

  • #, ##, … -> <h1>, <h2>, …
  • --- -> <hr>
  • Unordered/ordered list
  • ![](), <img> -> <img>
  • []() -> <a>
  • Plain text
  • Code blocks (``` ``` )
  • Inline code blocks (`` )

How to use (in Windows)

  1. Download and unzip markdown2html-x.x.x.zip from this page.
  2. Open markdown2html.exe and follow the instruction:
  3. Input Markdown file path: you need to enter the path to your markdown file. This path can be absolute or be relative to the path where the .exe locates. It is recommended to copy the markdown file into the folder where the exe is located so that you only need to type in the file name of the markdown file.
  4. Input output file path: this is the same as 3, but it specifies where you wish the output file is.
  5. Choose theme: enter a number.

Fun fact

My website is generated by this program.

effect

Themes

Themes are now supported.

There are a total of 7 themes.

  • default
  • githubDark
  • githubLight
  • dark
  • light
  • darkCompact
  • lightCompact

For developers

Github Repo

How to compile

The project uses CMake as building tool.

Structure of the project

z1s2TK.png

Core function convertTo(ofstream&)

Effect: convert a Markdown source to a HTML/Vue source into a given ofstream passed by reference.

lNum, lType are two stack used to deal with nested ordered/unordered list.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
void MarkdownSource::convertTo(ofstream& outFile) {
    Type lType[100] = {Text};
    int lNum[100] = {0}, lSize = 0, index = -1;
    lNum[0] = -10;
    bool isInCodeBlocks = false;
    for (auto l : lines) {
        index++;
        int i = 0, len = l.length();
        if (types[index] == CodeBlock) {
            if (l.substr(0, 3) == "```") {
                if (!isInCodeBlocks) {
                    outFile << "<pre>" << endl;
                } else {
                    outFile << "</pre>" << endl;
                }
                isInCodeBlocks = !isInCodeBlocks;
            } else {
                outFile << l << endl;
            }
            continue;
        }
        if (len == 0) {
            if (lSize == 0) {
                if (index > 0 && index < size - 1 && lines[index - 1].length() > 0 && lines[index + 1].length() > 0 && startWith(lines[index - 1], 0) == Text && startWith(lines[index + 1], 0) == Text) {
                    outFile << "<br>" << endl;
                }
            } else {
                while (lSize > 0) {
                    outFile << "</li>" << endl
                            << ((lType[lSize] == Uli)
                                    ? "</ul>"
                                    : "</ol>")
                            << endl;
                    lSize--;
                }
            }
            continue;
        }

        Type theType = startWith(l, 0);

        if (theType == Hr) {
            outFile << "<hr>";
            continue;
        }

        if (theType == Title) {
            int spacePos = findChar(l, i, ' ', "");
            outFile << "<h" << spacePos << ">" << endl;
            processLine(l, spacePos + 1, outFile);
            outFile << "</h" << spacePos << ">" << endl;
            continue;
        }

        if (theType == Uli || theType == Oli) {
            string meStart = "<ul>", meEnd = "</ul>", youStart = "<ol>", youEnd = "</ol>";
            if (theType == Oli) {
                swap(meEnd, youEnd);
                swap(meStart, youStart);
            }
            int indentCnt = (theType == Uli) ? findChar(l, i, '-', "") : findDigit(l, i);
            if (lType[lSize] == theType && lNum[lSize] == indentCnt) {
                outFile << "</li>" << endl;
            } else if (indentCnt - lNum[lSize] >= 2) {
                lSize++;
                lNum[lSize] = indentCnt;
                lType[lSize] = theType;
                outFile << meStart << endl;
            } else {
                // not the same type of list or higher level
                while (lSize > 0 && ((lType[lSize] != theType && lNum[lSize] == indentCnt) || lNum[lSize] - indentCnt >= 2)) {
                    outFile
                        << "</li>" << endl
                        << (lType[lSize] == theType ? meEnd : youEnd) << endl;
                    lSize--;
                }
                if (lSize > 0 && lType[lSize] == theType) {
                    // same level & same type
                    outFile << "</li>" << endl;
                } else {
                    // different level || different type
                    lSize++;
                    lNum[lSize] = indentCnt;
                    lType[lSize] = theType;
                    outFile << meStart << endl;
                }
            }
            outFile << "<li>" << endl;
            processLine(l, (theType == Uli) ? indentCnt + 2 : findChar(l, indentCnt, '.', "") + 2, outFile);
            continue;
        }
        processLine(l, 0, outFile);
    }
}