-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreadme.html
More file actions
160 lines (140 loc) · 7.82 KB
/
readme.html
File metadata and controls
160 lines (140 loc) · 7.82 KB
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html lang="en">
<head><title>Home</title>
<meta charset="utf-8">
<link rel="shortcut icon" type="image/png" href="doc/favicon.png">
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="doc/layout/content.css">
<link rel="stylesheet" type="text/css" href="doc/layout/more_prog_langs.css">
<link rel="stylesheet" type="text/css" href="doc/themes/light/content_theme.css">
<link rel="stylesheet" type="text/css" href="doc/themes/light/more_prog_langs_theme.css">
<link rel="stylesheet" type="text/css" href="doc/layout/layout.css">
<link rel="stylesheet" type="text/css" href="doc/themes/light/layout_theme.css">
<link rel="stylesheet" type="text/css" href="doc/custom.css">
<link rel="stylesheet" type="text/css" href="doc/layout/flex.css">
</head>
<body>
<div class="header">
<img id="burger" src="doc/layout/pict/burger.png"
onclick="toggleSidebar();return false;" class="toggle_narrow_only_inline" alt="Sidebar">
<a
class="header_item selected "
href="readme.html"><img
class="logo_image" src="doc/favicon.png" alt="Logo"></a><a
class="header_item selected toggle_wide_only_inline"
href="readme.html"><span>Home</span></a><a
class="header_item toggle_wide_only_inline"
href="doc/content/sections/installation.html"><span>Installation</span></a><a
class="header_item toggle_wide_only_inline"
href="doc/content/sections/usage.html"><span>Usage</span></a><a
class="header_item toggle_wide_only_inline"
href="doc/content/index_page.html"><span>Index</span></a><a
class="header_item toggle_narrow_only_inline"
href="doc/content/index_page.html"><img
class="header_image index_image" src="doc/layout/pict/search.png" alt="Index"></a><a
class="header_item toggle_wide_only_inline "
href="https://github.com/arctrong/md2html"><span class="">GitHub</span></a>
<a href="readme.txt" class="source_file toggle_wide_only_inline" title="Source text"></></a>
<img class="headerNavArrows" src="doc/layout/pict/previous_page_h21px_inactive.png"
alt="No back">
<a href="doc/content/sections/overview.html" title="Next: Overview"><img class="headerNavArrows"
src="doc/layout/pict/next_page_h21px.png" alt="Next"></a>
<span class="headerTitle">Home</span>
</div>
<div class="sidebarWrapper">
<div class="sidebar">
<table class="sidebarAligner">
<tr><td class="valign_top">
<div class="align_right toggle_narrow_only_block">
<a class="sidebar_item_inline align_right" href="https://github.com/arctrong/md2html">GitHub</a>
<a href="readme.txt" class="sidebar_item_inline source_file align_right"
title="Source text"></></a>
</div>
<div class="sidebar_block">
<a class="sidebar_item selected " href="readme.html">Home</a>
<a class="sidebar_item " href="doc/content/sections/overview.html">Overview</a>
<a class="sidebar_item " href="doc/content/sections/quick_start.html">Quick start</a>
<a class="sidebar_item " href="doc/content/sections/installation.html">Installation</a>
<a class="sidebar_item " href="doc/content/sections/usage.html">Usage</a>
<a class="sidebar_item " href="doc/content/sections/page_content.html">Page content</a>
<a class="sidebar_item " href="doc/content/sections/page_content_dark.html">Page content (dark)</a>
<a class="sidebar_item " href="doc/content/sections/templates.html">Templates</a>
<a class="sidebar_item " href="doc/content/sections/plugins.html">Plugins</a>
<a class="sidebar_item " href="doc/content/sections/reference.html">Technical reference</a>
<a class="sidebar_item " href="doc/content/sections/troubleshooting.html">Troubleshooting</a>
<a class="sidebar_item " href="doc/content/sections/development.html">Development</a>
</div><div class="sidebar_block">
<a class="sidebar_item " href="doc/content/sections/ref/glossary.html">Glossary</a>
<a class="sidebar_item " href="doc/content/sections/ref/references.html">References</a>
</div>
</td></tr>
<tr><td class="bottom valign_bottom"><span class="poweredBy">Powered by <a class="poweredByLink"
href="https://github.com/arctrong/md2html">md2html_py</a> 1.0.8</span>
</td></tr>
</table>
</div>
</div>
<p><img alt="Logo" class="floatRight" src="doc/pict/logo.png" title="md2html" /></p>
<p><strong>M<sub>2</sub>H</strong> creates structured, well-formatted static HTML sites with minimal effort.
It can be used for many kinds of writing projects.</p>
<p>This documentation was written entirely using <strong>M<sub>2</sub>H</strong> and serves as a real-world
example of the tool in action.</p>
<div class="toc">
<ul>
<li><a href="#how-it-works">How it works</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#implementation">Implementation</a></li>
</ul>
</div>
<p style="clear: both;"></p>
<h1 id="how-it-works">How it works</h1>
<p>You write a Markdown text like this:</p>
<pre class="highlight"><code>!!! note
A **monad** is just a _monoid_ in the category of `endofunctors`.</code></pre>
<p><strong>M<sub>2</sub>H</strong> converts it into HTML code like this:</p>
<pre class="highlight"><code class="language-wrapped-html"><div class="admonition note">
<p class="admonition-title">Note</p>
<p>A <strong>monad</strong> is just a <em>monoid</em> in the category of <code>endofunctors</code>.</p>
</div></code></pre>
<p>Then it includes this code into a specially prepared HTML template and produces the page that
looks like this:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A <strong>monad</strong> is just a <em>monoid</em> in the category of <code>endofunctors</code>.</p>
</div>
<h1 id="features">Features</h1>
<p><strong>M<sub>2</sub>H</strong> automates the conversion of Markdown texts into HTML pages and provides templates
and styles that are either ready to use or easy to adapt and extend.</p>
<p>In addition, it supports processing whole document sets, organizing the output, and producing
self-contained static HTML sites that needs only a browser to be viewed.</p>
<p>Finally, <strong>M<sub>2</sub>H</strong> includes plugins that automate common tasks and help the result
look professional.</p>
<p><strong>M<sub>2</sub>H</strong> doesn't impose many restrictions on project organization and lets users define
their own configuration. Still, it provides recommended project structures described in this
manual and implemented in the quick start scripts.</p>
<h1 id="implementation">Implementation</h1>
<p><strong>M<sub>2</sub>H</strong> is a command line utility available in two versions: Python and Java. They work
mostly the same way, share the same command line syntax, and process the same inputs. The versions
are independent and can be used separately, but they are shipped together as source code and share
common artifacts (templates, styles, scripts, and this documentation). This manual describes the
both versions.</p>
<p> </p>
<hr />
<p style="margin-top:0px;margin-bottom:0px;text-align:right;"><img src="doc/layout/pict/previous_page_inactive.png"
alt="No back">
<a href="doc/content/sections/overview.html" title="Next: Overview"><img
src="doc/layout/pict/next_page.png" alt="Next"></a>
</p>
<script>
function toggleSidebar() {
let sidebar = document.getElementsByClassName("sidebarWrapper")[0]
let display = sidebar.style.display
if (!display || display == "none") {
sidebar.style.display = "block"
} else {
sidebar.style.display = ""
}
}
</script>
</body>
</html>