-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathabout.html
429 lines (364 loc) · 18.5 KB
/
about.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<!DOCTYPE html>
<!--[if IE 6]><html lang="en" class="preIE7 preIE8 preIE9 preIE10 preIE11"><![endif]-->
<!--[if IE 7]><html lang="en" class="preIE8 preIE9 preIE10 preIE11"><![endif]-->
<!--[if IE 8]><html lang="en" class="preIE9 preIE10 preIE11"><![endif]-->
<!--[if IE 9]><html lang="en" class="preIE10 preIE11"><![endif]-->
<!--[if IE 10]><html lang="en" class="preIE11"><![endif]-->
<!--[if gte IE 11]><!--><html lang="en"><!--<![endif]-->
<head>
<meta charset="utf-8">
<!-- browser/device compatibility stuff -->
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="HandheldFriendly" content="True"/>
<meta name="format-detection" content="telephone=no">
<!-- page info -->
<title>mdsh | mdsh </title>
<meta name="description" content="a simple static site generator for modern websites, written in Bash.">
<meta name="keywords" content="mdsh, static site generator, project page, open source, blog, news, feed">
<meta name="news_keywords" content="mdsh, static site generator, project page, open source, blog, news, feed">
<meta name="subject" content="mdsh, static site generator, project page, open source, blog, news, feed">
<meta name="generator" content="mdsh">
<meta name="medium" content="blog">
<meta name="copyright" content="© mdsh">
<meta name="language" content="en">
<meta name="robots" content="index,follow">
<meta name="topic" content="mdsh, static site generator, project page, open source, blog, news, feed">
<meta name="owner" content="sc0ttj">
<meta name="pagename" content="mdsh">
<!-- Apple -->
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-title" content="mdsh">
<!-- Facebook -->
<meta property="og:title" content="mdsh">
<meta property="og:description" content="a simple static site generator for modern websites, written in Bash.">
<meta property="og:url" content="https://sc0ttj.github.io/mdsh">
<meta property="og:site_name" content="mdsh">
<meta property="og:type" content="article">
<meta property="og:locale" content="en">
<meta property="og:image" content="https://sc0ttj.github.io/mdsh/assets/icons/rss.png">
<meta property="article:author" content="sc0ttj">
<meta property="article:section" content="">
<meta property="article:published_time" content="">
<meta property="article:modified_time" content="2019-10-22T06:47:33Z">
<!-- Twitter -->
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="mdsh">
<meta name="twitter:site" content="@foobar">
<meta name="twitter:creator" content="@foobar">
<meta name="twitter:image" content="https://sc0ttj.github.io/mdsh/assets/icons/rss.png">
<meta name="twitter:domain" content="https://sc0ttj.github.io/mdsh">
<!-- Linked data -->
<script id="meta-ld" type="application/ld+json">
{
"@context": "http://schema.org/",
"@type": "Article",
"headline": "mdsh",
"datePublished": "",
"dateModified": "2019-10-22T06:47:33Z",
"description": "a simple static site generator for modern websites, written in Bash.",
"keywords": "mdsh, static site generator, project page, open source, blog, news, feed",
"image": {
"@type": "ImageObject",
"height": "512",
"width": "512",
"url": "https://sc0ttj.github.io/mdsh/assets/icons/android-chrome-512x512.png"
},
"author": "sc0ttj",
"publisher": {
"@type": "Organization",
"logo": {
"@type": "ImageObject",
"url": "https://sc0ttj.github.io/mdsh/assets/icons/android-chrome-512x512.png"
},
"name": "mdsh"
},
"mainEntityOfPage": "https://sc0ttj.github.io/mdsh#content",
"articleBody": "a simple static site generator for modern websites, written in Bash."
}
</script>
<script id="breadcrumb-ld" type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "BreadcrumbList",
"itemListElement":
[
{
"@type": "ListItem",
"position": 1,
"item":
{
"@id": "https://sc0ttj.github.io/mdsh",
"name": "Mdsh"
}
}
]
}
</script>
<script id="itemlist-ld" type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "ItemList",
"itemListElement":
[
{
"@type": "ListItem",
"position": 1,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/10/04/how-to-setup-e-commerce-with-mdsh.html"
},
{
"@type": "ListItem",
"position": 2,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/14/embedding-youtube-videos-tweets-codepens-and-other-third-party-content.html"
},
{
"@type": "ListItem",
"position": 3,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/14/easier-stylesheet-selection.html"
},
{
"@type": "ListItem",
"position": 4,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/13/easier-layout-selection.html"
},
{
"@type": "ListItem",
"position": 5,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/13/better-site-rebuilding.html"
},
{
"@type": "ListItem",
"position": 6,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/11/permalinks-for-your-posts.html"
},
{
"@type": "ListItem",
"position": 7,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/09/07/better-data-and-template-handling.html"
},
{
"@type": "ListItem",
"position": 8,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/07/13/liquid-filters.html"
},
{
"@type": "ListItem",
"position": 9,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/07/01/faster-site-rebuilds.html"
},
{
"@type": "ListItem",
"position": 10,
"url": "https://sc0ttj.github.io/mdsh/posts/2019/06/29/adding-support-for-more-embedded-languages.html"
}
]
}
</script>
<!-- RSS feed -->
<link rel="alternate" type="application/rss+xml" title="Subscribe to mdsh" href="/mdsh/feed.rss">
<!-- SEO stuff -->
<link rel="author" href="/humans.txt">
<link rel="canonical" href="//sc0ttj.github.io/mdsh">
<!-- App icons and favicons -->
<link rel="manifest" href="/mdsh/manifest.webmanifest?v=1571726861">
<link rel="icon" type="image/png" sizes="16x16" href="/mdsh/assets/icons/favicon-16x16.png?v=1571726861">
<link rel="icon" type="image/png" sizes="32x32" href="/mdsh/assets/icons/favicon-32x32.png?v=1571726861">
<link rel="icon" type="image/png" sizes="192x192" href="/mdsh/assets/icons/android-chrome-192x192.png?v=1571726862">
<link rel="icon" type="image/vnd.microsoft.icon" href="/mdsh/assets/icons/favicon.ico?v=1571726862">
<link rel="apple-touch-icon" sizes="180x180" href="/mdsh/assets/icons/apple-touch-icon.png?v=1571726862">
<link rel="shortcut icon" href="/mdsh/assets/icons/favicon.ico?v=1571726862">
<link rel="mask-icon" color="#444444" href="/mdsh/assets/icons/safari-pinned-tab.svg?v=1571726862">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-config" content="/mdsh/assets/icons/browserconfig.xml?v=1571726862">
<meta name="theme-color" content="#101010">
<!-- Fallback app name, for legacy browsers -->
<meta name="application-name" content="mdsh">
<!-- prefetch resources -->
<link rel="dns-prefetch" href="//unpkg.com">
<link rel="preconnect" href="//unpkg.com" crossorigin>
<!-- CSS -->
<style>/* inline styles go here */</style>
<link rel="stylesheet" href="/mdsh/assets/css/main.min.css?v=1571726862">
<!-- pygments (syntax highlighting) -->
<link rel="stylesheet" href="/mdsh/assets/css/pygments-monokai-osx.css?v=1571726862">
<!-- JavaScript -->
<!--[if lt IE 9]>
<script>
// enable styling of HTML5 elements in IE < 9
document.createElement('header');
document.createElement('nav');
document.createElement('main');
document.createElement('section');
document.createElement('article');
document.createElement('aside');
document.createElement('footer');
document.createElement('picture');
document.createElement('time');
document.createElement('site');
document.createElement('data');
document.createElement('figure');
document.createElement('aside');
document.createElement('address');
</script>
<![endif]-->
<!-- load site NPM deps, if any -->
<script class="unpkg" defer src="//unpkg.com/[email protected]/dist/cash.min.js"></script>
<script class="unpkg" defer src="//unpkg.com/[email protected]/jets.min.js"></script>
<!-- load page-specific NPM deps, if any -->
<!-- main javascript app -->
<script id="appjs" defer src="/mdsh/assets/js/app.js?v=1571726862"></script>
</head>
<!-- start body -->
<body class="no-js category-blog mdsh">
<div class="main-container">
<div class="site-header">
<h1><a href="/mdsh">mdsh</a></h1>
<input type="search" class="site-search" id="site-search" placeholder="filter.." />
<a class="off-screen skip-to-content" href="#content">Skip to content</a>
<ul>
<li><a href="/mdsh/about.html">about</a></li>
<li><a href="/mdsh/archive.html">archive</a></li>
<li><a href="/mdsh/contact.html">contact</a></li>
<li><a href="/mdsh/search.html">search</a></li> </ul>
</div>
<div class="body-container">
<div id="content" class="main-content">
<h2>mdsh</h2>
<h1 id="_readme_">README</h1>
<p><code>mdshell</code> - Write your blog straight from the terminal.</p>
<h2 id="_description_">Description</h2>
<p>This is a simple static site generator (SSG), or "blog making thing".</p>
<p><code>mdshell</code> requires only Bash and Perl, and builds HTML files from Markdown files.</p>
<p>The name <code>mdshell</code> refers to the fact you can combine Markdown and Bash sub-shells in your blog posts to dynamically produce the HTML output.</p>
<p>This is a fast way of producing documentation for any installed programs or commands, and a nice easy way to write blog posts in Markdown.</p>
<h2 id="_features_">Features</h2>
<ul>
<li>Written in Bash shell script</li>
<li>Simple command-line interface (use in the terminal)</li>
<li>Builds a fast blog with great SEO and mobile support</li>
<li>Creates blog posts or custom pages, built from Markdown or HTML.</li>
<li>Generates index pages for categories, tags, authors and more.</li>
<li>Generates a valid RSS feed and XML sitemap.</li>
<li>Define your <a href="https://sc0ttj.github.io/mdsh/posts/2019/09/07/better-data-and-template-handling.html">site and page data</a> in <code>assets/data/</code> as YAML, CSV or Bash variables & arrays</li>
<li>Uses a mustache-like templating system, with <a href="https://sc0ttj.github.io/mdsh/posts/2019/07/13/liquid-filters.html">liquid-style filters</a></li>
<li>Auto convert URLs to <a href="https://sc0ttj.github.io/mdsh/posts/2019/09/14/embedding-youtube-videos-tweets-codepens-and-other-third-party-content.html">embedded content</a> for Youtube, Twitter, Instagram, etc..</li>
<li>Embed shell, python, ruby etc, in your Markdown to create <a href="https://sc0ttj.github.io/mdsh/posts/2019/06/29/adding-support-for-more-embedded-languages.html">dynamic Markdown</a> output!</li>
<li>Includes a "Contact" page that works out of the box! (uses <a href="http://formspree.io">formspree.io</a>, requires JS)</li>
<li>Includes a fast page search, with highlighted matches (uses <a href="https://jets.js.org/">Jets</a>, requires JS)</li>
<li>Supports fullscreen, native app experience on mobile if added to Homescreen</li>
<li>Supports code syntax highlighting (requires <a href="http://pygments.org/">Pygments</a>, default theme is <code>monokai</code>)</li>
<li>Optionally use <a href="https://fonts.google.com/">Google Fonts</a> to choose custom web fonts</li>
<li>Optionally use <a href="http://unpkg.com">Unpkg.com</a> to manage JavaScript libraries/dependencies</li>
<li>Optionally use <a href="https://kbroman.org/github_tutorial/">Git</a> for saving, managing and reverting versions and deployments</li>
<li>Optionally use <a href="https://pages.github.com/">GitHub Pages</a> for free, fast, and secure (SSL enabled) site hosting</li>
<li>Supports many other web hosting options too (<a href="https://about.gitlab.com/product/pages/">GitLab Pages</a>, <a href="https://www.netlify.com/docs/continuous-deployment/">Netlify</a>, others).</li>
</ul>
<h2 id="_setup_">Setup</h2>
<p><code>.app/setup.sh</code> - set site defaults, settings and options.</p>
<p><code>source .site_setup</code> - source the app and site settings - <em>important!</em></p>
<p><code>server [start|stop]</code> - start/stop a local web server.</p>
<h2 id="_usage_">Usage</h2>
<p><code>new post</code> - create a new post. Follow the on-screen instructions - a <code>.mdsh</code> file will be created for you containing your chosen options as YAML front matter. After you've saved your new post, all relevant index pages will be updated and re-built.</p>
<p><code>publish "message"</code> - save and publish latest changes.</p>
<h2 id="_advanced_usage_">Advanced usage</h2>
<h4>Customising posts</h4>
<p><code>new post -all</code> - creates a new post, as above, but allows overriding various site defaults.</p>
<h4>Creating pages</h4>
<p><code>rebuild file.mdsh > file.html</code> - create a page from a <code>.mdsh</code> file (recommended).</p>
<p><code>rebuild file.md > file.html</code> - create a page from a Markdown file.</p>
<p><code>rebuild "$html" > file.html</code> - create a page from an HTML string.</p>
<p>Or manually:</p>
<div class="highlight"><pre><span></span><span class="nv">page_title</span><span class="o">=</span><span class="s2">"My cool page"</span> <span class="se">\</span>
<span class="nv">page_slug</span><span class="o">=</span><span class="s2">"my-cool-page"</span> <span class="se">\</span>
<span class="nv">page_descr</span><span class="o">=</span><span class="s2">"Some thing"</span> <span class="se">\</span>
<span class="nv">page_layout</span><span class="o">=</span><span class="s2">"main"</span> <span class="se">\</span>
<span class="nv">page_stylesheet</span><span class="o">=</span><span class="s2">"main"</span> <span class="se">\</span>
.app/create_page.sh <span class="s2">"</span><span class="nv">$body_html</span><span class="s2">"</span> > my-cool-page.html
</pre></div>
<h4>Rebuilding pages</h4>
<p>If you edit any existing Markdown or .mdsh files, you may need to re-build the HTML pages:</p>
<p><code>rebuild</code> - re-build all index pages (authors, categories, tags, etc).</p>
<p><code>rebuild file.mdsh file.html</code> - re-build a specific page from a .mdsh file (recommended).</p>
<p><code>rebuild file.md file.html</code> - re-build a specific page from its Markdown file.</p>
<p><code>rebuild -all</code> - re-build all posts from their Markdown files.</p>
<p><code>rebuild -ALL</code> - re-build all posts from their .mdsh files.</p>
<p><code>rebuild tags:foo,bar</code> - rebuild tag index pages for tags <code>foo</code> and <code>bar</code></p>
<p><code>rebuild authors:sc0ttj homepage</code> - rebuild author page for sc0ttj, and the homepage</p>
<h4>Updating sitemap</h4>
<p><em>After</em> publishing your new post or page, you can update your sitemap.</p>
<p><code>rebuild sitemap</code> - re-build and publish an updated XML sitemap file.</p>
<h2 id="_documentation_">Documentation</h2>
<p>Type <code>help</code> in the terminal.</p>
<p>Also, read the <a href="https://github.com/sc0ttj/mdsh/wiki">wiki</a> for more help and usage information.</p>
<h2 id="_to_do_">To do</h2>
<p>See <a href="https://github.com/sc0ttj/mdsh/issues">Issues page</a> for planned features and known bugs.</p>
</div>
</div>
<ul id="site-navigation" class="site-navigation">
<li class="site-navigation--main-pages">
<h3>Pages</h3>
<ul>
<li><a href="/mdsh/about.html">About</a></li>
<li><a href="/mdsh/archive.html">Archive</a></li>
<li><a href="/mdsh/contact.html">Contact</a></li>
<li><a href="/mdsh/search.html">Search</a></li> </ul>
</li>
<li class="site-navigation--recent-posts">
<h3>Recent posts</h3>
<ul>
<li><a href="/mdsh/posts/2019/10/04/how-to-setup-e-commerce-with-mdsh.html">How to setup e-commerce with Mdsh</a></li>
<li><a href="/mdsh/posts/2019/09/14/embedding-youtube-videos-tweets-codepens-and-other-third-party-content.html">Embedding Youtube videos, Tweets, Codepens and other third-party content</a></li>
<li><a href="/mdsh/posts/2019/09/14/easier-stylesheet-selection.html">Easier stylesheet selection</a></li>
<li><a href="/mdsh/posts/2019/09/13/easier-layout-selection.html">Easier layout selection</a></li>
<li><a href="/mdsh/posts/2019/09/13/better-site-rebuilding.html">Better site rebuilding</a></li> </ul>
</li>
<li class="site-navigation--categories">
<h3>Categories</h3>
<ul>
<li>
<a href="/mdsh/categories/blog.html">blog</a>
</li>
<li>
<a href="/mdsh/categories/games.html">games</a>
</li> </ul>
</li>
<li class="site-navigation--tags">
<h3>Tags</h3>
<div>
<a href="/mdsh/tags/bash.html">bash</a>,
<a href="/mdsh/tags/blog.html">blog</a>,
<a href="/mdsh/tags/bsd.html">bsd</a>,
<a href="/mdsh/tags/css.html">css</a>,
<a href="/mdsh/tags/csv.html">csv</a>,
<a href="/mdsh/tags/ecommerce.html">ecommerce</a>,
<a href="/mdsh/tags/games.html">games</a>,
<a href="/mdsh/tags/git.html">git</a>,
<a href="/mdsh/tags/gnu.html">gnu</a>,
<a href="/mdsh/tags/html.html">html</a>,
<a href="/mdsh/tags/javascript.html">javascript</a>,
<a href="/mdsh/tags/js.html">js</a>,
<a href="/mdsh/tags/json-ld.html">json-ld</a>,
<a href="/mdsh/tags/linux.html">linux</a>,
<a href="/mdsh/tags/liquid-templating.html">liquid-templating</a>,
<a href="/mdsh/tags/markdown.html">markdown</a>,
<a href="/mdsh/tags/mdsh.html">mdsh</a>,
<a href="/mdsh/tags/mustache.html">mustache</a>,
<a href="/mdsh/tags/oembed.html">oembed</a>,
<a href="/mdsh/tags/osx.html">osx</a>,
<a href="/mdsh/tags/paypal.html">paypal</a>,
<a href="/mdsh/tags/pygments.html">pygments</a>,
<a href="/mdsh/tags/rss.html">rss</a>,
<a href="/mdsh/tags/search.html">search</a>,
<a href="/mdsh/tags/sed.html">sed</a>,
<a href="/mdsh/tags/seo.html">seo</a>,
<a href="/mdsh/tags/shell.html">shell</a>,
<a href="/mdsh/tags/xml.html">xml</a>,
<a href="/mdsh/tags/yaml.html">yaml</a>, </div>
</li>
</ul>
<div class="site-footer">
<p>© mdsh, 2019. Powered by <a href="https://sc0ttj.github.io/mdsh/">mdsh</a></p>
</div>
</div>
</body>
</html>