-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
137 lines (129 loc) · 18.9 KB
/
index.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 5.5.3">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>MarkBind - Generate More Dynamic Websites from Markdown Text</title> <link rel="stylesheet" href="/markbind/css/bootstrap.min.css"> <link rel="stylesheet" href="/markbind/fontawesome/css/all.min.css"> <link rel="stylesheet" href="/markbind/glyphicons/css/bootstrap-glyphicons.min.css"><link rel="stylesheet" href="/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/markbind/css/markbind.min.css"><link rel="stylesheet" href="/plugins/web3Form/web-3-form.css"><link rel="stylesheet" href="/plugins/dataTable/datatables.min.css"><link rel="stylesheet" href="/plugins/dataTable/datatables-additional.css"><link rel="stylesheet" href="/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/plugins/markbind-plugin-tree/markbind-plugin-tree.css">
<link rel="stylesheet" href="/css/main.css">
<link rel="icon" href="/favicon.ico"></head>
<script>
const baseUrl = ''
</script>
<body >
<div id="app" data-server-rendered="true"><header sticky=""><div data-v-7c0fd418><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-7c0fd418><div class="container-fluid" data-v-7c0fd418><div class="navbar-left" data-v-7c0fd418><a href="/index.html" title="Home" class="navbar-brand" data-v-7c0fd418><img src="/images/logo-darkbackground.svg" height="20" data-v-7c0fd418></a></div> <div class="navbar-default" data-v-7c0fd418><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-7c0fd418> <li data-v-7c0fd418><a highlight-on="exact" href="/index.html" class="nav-link" data-v-7c0fd418>HOME</a></li> <div tags="environment--ug environment--combined" data-v-7c0fd418><li data-v-7c0fd418><a highlight-on="sibling-or-child" href="/userGuide/index.html" class="nav-link" data-v-7c0fd418>USER GUIDE</a></li></div> <li data-v-7c0fd418><a highlight-on="exact" href="/showcase.html" class="nav-link" data-v-7c0fd418>SHOWCASE</a></li> <li data-v-7c0fd418><a highlight-on="exact" href="/about.html" class="nav-link" data-v-7c0fd418>ABOUT</a></li> <li data-v-7c0fd418><a href="https://github.com/MarkBind/markbind" target="_blank" class="nav-link" data-v-7c0fd418><span data-v-7c0fd418><span aria-hidden="true" class="fab fa-github" data-v-7c0fd418></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-7c0fd418><li data-v-7c0fd418><form class="navbar-form" data-v-7c0fd418><div class="dropdown" style="position:relative;" data-v-4f6e9aec><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-4f6e9aec> <div class="form-control placeholder-div-hidden" data-v-4f6e9aec>
Search
</div> <ul class="dropdown-menu search-dropdown-menu dropdown-menu-hidden dropdown-menu-end" data-v-4f6e9aec></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-7c0fd418><!----> <!----></div></div></header> <div id="flex-body"><div id="content-wrapper"><div tags="environment--ug environment--combined"><h1 id="markbind" class="display-3"><span><strong>MarkBind</strong></span><a href="#markbind" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p><span class="large"><strong>Generate <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----><!----></span> websites from Markdown text.</strong></span>
Optimized for creating text-heavy websites <span class="dimmed">e.g., eLearning websites, online instruction manuals, project documentation etc.</span></p></div> <p><a href="/userGuide" class="btn btn-primary">Get Started</a></p> <hr> <h4 id="simple-syntax-dynamic-content"><span style="color:#00B0F0;"><span aria-hidden="true" class="fas fa-check-circle"></span></span> Simple syntax. Dynamic content.<a href="#simple-syntax-dynamic-content" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>MarkBind source files can be as simple as basic Markdown, but you can also <a href="/userGuide/markBindSyntaxOverview.html"><strong>use a mix of several popular syntax schemes</strong></a> (<span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----><!----></span>, Bootstrap, Nunjucks, etc. as well as MarkBind's own custom syntax) to create more dynamic content that you cannot normally get from a typical markdown-to-html site generator.</p> <p>Here are some simple text-formatting examples:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Syntax scheme</th> <th>Code</th> <th>Output</th></tr></thead> <tbody><tr><td>Markdown</td> <td><code class="hljs inline no-lang">**bold text** _italic text_</code></td> <td><strong>bold text</strong> <em>italic text</em></td></tr> <tr><td>GFMD</td> <td><code class="hljs inline no-lang">~~striked out text~~</code></td> <td><s>striked out text</s></td></tr> <tr><td>MarkBind extensions to Markdown</td> <td><code class="hljs inline no-lang">==highlighted text==</code><br><code class="hljs inline no-lang">%%grey text%%</code><br><code class="hljs inline no-lang">!!underlined text!!</code></td> <td><mark>highlighted text</mark><br><span class="dimmed">grey text</span><br><span class="underline">underlined text</span></td></tr></tbody></table></div><div class="card-container" data-v-c545cba4><div class="card expandable-card card-seamless border-0" data-v-c545cba4><div class="card-header header-toggle bg-transparent border-0" data-v-c545cba4><div class="caret-wrapper" data-v-c545cba4><span class="glyphicon glyphicon-chevron-right" data-v-c545cba4></span></div> <div class="header-wrapper-seamless header-wrapper card-title bg-transparent" data-v-c545cba4><p data-v-c545cba4><span class="dimmed" data-v-c545cba4>More examples of generating static content</span></p></div> <div class="button-wrapper" data-v-c545cba4><button type="button" class="collapse-button btn btn-outline-light" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light seamless-button" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-c545cba4></span></button> <button type="button" class="popup-button btn btn-outline-light seamless-button" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-c545cba4></span></button></div></div> <div class="card-collapse" data-v-c545cba4><!----> <hr style="display:;" data-v-c545cba4></div> <!----></div></div> <p></p> <p>The example paragraph below has the following dynamic elements: a tooltip, a popover, and a modal. Hover/click on the underlined words to see each.</p> <div class="alert box-container alert-default" data-v-474166ec><!----> <div class="header-and-body" data-v-474166ec><!----> <div class="box-body-wrapper" data-v-474166ec><!----> <!----> <div class="contents" data-v-474166ec><p data-v-474166ec>In <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----><!----></span>, a binary tree is a <span tabindex="0" class="trigger"><span>tree data structure</span></span> in which each node has at most two children, which are referred to as the <em data-v-474166ec>left child</em> and the <em data-v-474166ec>right child</em>. <span tabindex="0" class="trigger-click"><span>Primitive data types</span></span> on the other hand ...</p> <span data-mb-component-type="popover" tabindex="0" id="pop:index-tree" class="trigger"><!----><!----></span> <!----></div> <!----></div></div></div> <div class="card-container" data-v-c545cba4><div class="card expandable-card card-seamless border-0" data-v-c545cba4><div class="card-header header-toggle bg-transparent border-0" data-v-c545cba4><div class="caret-wrapper" data-v-c545cba4><span class="glyphicon glyphicon-chevron-right" data-v-c545cba4></span></div> <div class="header-wrapper-seamless header-wrapper card-title bg-transparent" data-v-c545cba4><p data-v-c545cba4><span class="dimmed" data-v-c545cba4>More examples of generating dynamic content</span></p></div> <div class="button-wrapper" data-v-c545cba4><button type="button" class="collapse-button btn btn-outline-light" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light seamless-button" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-c545cba4></span></button> <button type="button" class="popup-button btn btn-outline-light seamless-button" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-c545cba4></span></button></div></div> <div class="card-collapse" data-v-c545cba4><!----> <hr style="display:;" data-v-c545cba4></div> <!----></div></div> <p></p> <hr> <h4 id="everything-you-need-for-text-heavy-websites-built-in"><span style="color:#00B0F0;"><span aria-hidden="true" class="fas fa-check-circle"></span></span> Everything you need for text-heavy websites, built-in.<a href="#everything-you-need-for-text-heavy-websites-built-in" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>MarkBind is <strong>highly optimized for creating text-heavy websites</strong> <span class="dimmed">e.g., eLearning websites, online instruction manuals, project documentation etc.</span> Anything that you might need for creating such websites are built-in, sparing you the hassle of finding/installing/searching plugins that you need.</p> <p>Here are some examples:</p> <div class="indented"><p><span class="large"><span aria-hidden="true" class="fas fa-heart"></span></span> <strong>Icons</strong> can improve the readability of a text-heavy document. MarkBind comes with a wide selection of <a href="/userGuide/formattingContents.html#icons">icons</a> and <a href="/userGuide/formattingContents.html#emoji">emoji</a>.<br> <span class="large"><span aria-hidden="true" class="fas fa-search"></span></span> With MarkBind's <a href="/userGuide/makingTheSiteSearchable.html"><strong>search feature</strong></a>, you can allow readers to search for keywords in your site.<br> <span class="large"><span aria-hidden="true" class="fas fa-window-maximize"></span></span> MarkBind allows you to add <a href="/userGuide/tweakingThePageStructure.html"><strong>site/page navigation menus, headers, footers</strong></a> easily.</p></div> <hr> <h4 id="more-control-to-the-reader-without-duplicating-code"><span style="color:#00B0F0;"><span aria-hidden="true" class="fas fa-check-circle"></span></span> More control to the reader, without duplicating code.<a href="#more-control-to-the-reader-without-duplicating-code" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>A MarkBind website can be a <em>buffet</em> of content, as opposed to a <em>set menu</em>: a site can have optional contents that the reader can access at her discretion, and the same content can be organized in multiple ways so that the reader can choose the one that fits the need. To <em>cater</em> (pun intended) for creating such buffet style websites, MarkBind has <strong><a href="/userGuide/reusingContents.html">reuse mechanisms</a> for presenting the same content in multiple ways without duplicating the source file</strong>.</p> <p>For example, MarkBind has a powerful <code class="hljs inline no-lang">include</code> mechanism that allows content fragments (i.e., a file or part of a file) to be reused at multiple places in the website. In the example below, both the modal and the expandable panel reuse the same content originating from a <em>single</em> source file.</p> <div class="alert box-container alert-default" data-v-474166ec><!----> <div class="header-and-body" data-v-474166ec><!----> <div class="box-body-wrapper" data-v-474166ec><!----> <!----> <div class="contents" data-v-474166ec><p data-v-474166ec>In CS, a binary tree is a tree data structure in which each node has at most two children, which are referred to as the <em data-v-474166ec>left child</em> and the <em data-v-474166ec>right child</em>. <span tabindex="0" class="trigger-click"><span>Primitive data types</span></span> on the other hand ...</p> <div class="card-container" data-v-c545cba4><div class="card expandable-card card-seamless border-0" data-v-c545cba4><div class="card-header header-toggle bg-transparent border-0" data-v-c545cba4><div class="caret-wrapper" data-v-c545cba4><span class="glyphicon glyphicon-chevron-right" data-v-c545cba4></span></div> <div class="header-wrapper-seamless header-wrapper card-title bg-transparent" data-v-c545cba4><p data-v-c545cba4><span class="dimmed" data-v-c545cba4><span aria-hidden="true" class="fas fa-info-circle" data-v-c545cba4></span> Some example primitive data types</span></p></div> <div class="button-wrapper" data-v-c545cba4><button type="button" class="collapse-button btn btn-outline-light" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light seamless-button" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-c545cba4></span></button> <button type="button" class="popup-button btn btn-outline-light seamless-button" style="display:none;" data-v-c545cba4><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-c545cba4></span></button></div></div> <div class="card-collapse" data-v-c545cba4><!----> <hr style="display:;" data-v-c545cba4></div> <!----></div></div> <!----></div> <!----></div></div></div> <hr> <h4 id="easy-to-set-up-modify-deploy-integrate"><span style="color:#00B0F0;"><span aria-hidden="true" class="fas fa-check-circle"></span></span> Easy to set up, modify, deploy, integrate.<a href="#easy-to-set-up-modify-deploy-integrate" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>Installing MarkBind takes just one command. Creating a new MarkBind site too takes just one command. With MarkBind's <em>live preview</em> feature, you can see how your site will look like as you modify the source file. <a href="/userGuide/deployingTheSite.html">Deploying the site to a server</a> can be as simple as one command too.</p> <p>As MarkBind is also optimized for project documentation, it can easily <a href="/userGuide/markBindInTheProjectWorkflow.html">integrate with the workflow of a software project</a>.</p> <p><a href="/userGuide" class="btn btn-primary">Get Started</a></p></div></div> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.5.3</a> on Sat, 7 Sept 2024, 6:44:10 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
</body><script src="/markbind/js/bootstrap-utility.min.js"></script>
<script src="/markbind/js/polyfill.min.js"></script>
<script src="/markbind/js/vue.min.js"></script>
<script src="/markbind/js/markbind.min.js"></script>
<script src="index.page-vue-render.js"></script>
<script>
MarkBind.setupWithSearch()
</script>
<script>
function toggleCodeBlockWrap(element) {
const pre = element.parentElement.parentElement;
const classList = pre.querySelector('code').classList;
if (classList.contains('wrap')) {
classList.remove('wrap');
} else {
classList.add('wrap')
}
}
</script>
<script>
function submitForm(element) {
event.preventDefault();
const formData = new FormData(element);
const formProps = Object.fromEntries(formData);
const json = JSON.stringify(formProps);
const submitButton = element.querySelector('button[type="submit"]');
const submitButtonText = submitButton.innerText;
submitButton.innerText = 'Please wait...'
fetch('https://api.web3forms.com/submit', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json'
},
body: json,
})
.then(async (response) => {
if (response.status == 200) {
alert('Form submitted! Thank you for your response');
} else {
alert('Error submitting form! Please try again later.');
}
})
.catch(error => {
alert('Error submitting form! Please try again later.');
})
.finally(() => {
submitButton.innerText = submitButtonText;
})
}
</script>
<script>
function copyCodeBlock(element) {
const pre = element.parentElement.parentElement;
const codeElement = pre.querySelector('code');
// create dummy text element to select() the text field
const textElement = document.createElement('textarea');
textElement.value = codeElement.textContent;
document.body.appendChild(textElement);
textElement.select();
document.execCommand('copy');
document.body.removeChild(textElement);
}
</script>
<script src="/plugins/dataTable/datatables.min.js"></script>
<script>
function getTableOptions(el) {
const options = {};
if ($(el).hasClass('sortable-table')) {
options.searching = false;
options.paging = false;
options.info = false;
} else if ($(el).hasClass('searchable-table')) {
options.ordering = false;
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
} else if ($(el).hasClass('sortable-searchable-table')) {
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
}
return options;
}
Vue.directive('datatable', {
inserted: function(el, binding) {
const options = binding.value || {};
const tableOptions = getTableOptions(el);
$(el).DataTable({ ...tableOptions, ...options });
}
});
document.addEventListener('DOMContentLoaded', function() {
$('table.sortable-table, table.searchable-table, table.sortable-searchable-table').each(function() {
const options = getTableOptions(this);
$(this).DataTable(options);
});
});
</script>
<script type="module">
import mermaid from 'https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs';
document.addEventListener('DOMContentLoaded', () => {
mermaid.initialize({});
Vue.directive('mermaid', {
inserted: function(el) {
mermaid.run({
nodes: [el]
});
}
});
});
</script>
</html>