205 lines
9.4 KiB
HTML
205 lines
9.4 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US">
|
||
<head>
|
||
<meta charset="utf-8"/>
|
||
<meta content="#0e1112" media="(prefers-color-scheme: dark)" name="theme-color"/>
|
||
<meta content="#566B78" media="(prefers-color-scheme: light)" name="theme-color"/>
|
||
<meta content="Michael Housh" name="author"/>
|
||
<meta content="Mhoush" name="apple-mobile-web-app-title"/>
|
||
<meta content="initial-scale=1.0, width=device-width" name="viewport"/>
|
||
<meta content="telephone=no" name="format-detection"/>
|
||
<meta content="True" name="HandheldFriendly"/>
|
||
<meta content="320" name="MobileOptimized"/>
|
||
<meta content="Mhoush" name="og:site_name"/>
|
||
<meta content="hvac, developer, swift, home-performance, design" name="keywords"/>
|
||
<title>
|
||
mhoush: You Should Learn Markdown
|
||
</title>
|
||
<link href="/static/favicon.ico" rel="shortcut icon"/>
|
||
<link href="/static/output.css" rel="stylesheet"/>
|
||
<link href="/static/style.css" rel="stylesheet"/>
|
||
<link href="/articles/feed.xml" rel="alternate" title="mhoush" type="application/rss+xml"/>
|
||
<link href="/static/prism.css" rel="stylesheet"/>
|
||
<meta content="This is a quick article about why you should learn markdown.
|
||
What is markdown
|
||
Markdown is a “mark-up” language. It allows you to write content in plain text that can be easily
|
||
converted to other formats, such as html, pdf, docx, and many more. All..." name="description"/>
|
||
<meta content="summary_large_image" name="twitter:card"/>
|
||
<meta content="http://localhost:3000/articles/images/2023-10-21-you-should-learn-markdown.png" name="twitter:image"/>
|
||
<meta content="You Should Learn Markdown" name="twitter:image:alt"/>
|
||
<meta content="http://localhost:3000/articles/images//articles/2023/you-should-learn-markdown/" name="og:url"/>
|
||
<meta content="You Should Learn Markdown" name="og:title"/>
|
||
<meta content="This is a quick article about why you should learn markdown.
|
||
What is markdown
|
||
Markdown is a “mark-up” language. It allows you to write content in plain text that can be easily
|
||
converted to other formats, such as html, pdf, docx, and many more. All..." name="og:description"/>
|
||
<meta content="http://localhost:3000/articles/images/2023-10-21-you-should-learn-markdown.png" name="og:image"/>
|
||
<meta content="1014" name="og:image:width"/>
|
||
<meta content="530" name="og:image:height"/>
|
||
<script crossorigin="anonymous" src="https://kit.fontawesome.com/f209982030.js">
|
||
</script>
|
||
</head>
|
||
<body class="bg-page text-white pb-5 font-avenir articles">
|
||
<header class="bg-nav text-gray py-4 text-base/6 lg:fixed w-full lg:h-[62px]">
|
||
<nav class="container flex gap-x-5 lg:gap-x-y items-center">
|
||
<ul class="flex flex-wrap gap-x-2 lg:gap-x-5">
|
||
<li>
|
||
<a class href="/">Home</a>
|
||
</li>
|
||
<li>
|
||
<a class="active" href="/articles/">Articles</a>
|
||
</li>
|
||
<li>
|
||
<a class href="/about/">About</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</header>
|
||
<div class="container pt-12 lg:pt-28">
|
||
<article class="prose">
|
||
<h1>
|
||
You Should Learn Markdown
|
||
</h1>
|
||
<div class="-mt-6">
|
||
<div class="text-gray gray-links text-sm">
|
||
<span class="border-r border-gray pr-2 mr-2">October 21, 2023</span>364 words, posted in <a href="/articles/tag/hvac/">HVAC</a>, <a href="/articles/tag/general/">general</a> and <a href="/articles/tag/programming/">programming</a>
|
||
</div>
|
||
</div>
|
||
<img alt="banner" src="http://localhost:3000/articles/images/2023-10-21-you-should-learn-markdown.png"/>
|
||
<p>This is a quick article about why you should learn markdown.</p>
|
||
<h2>What is markdown</h2>
|
||
<p>Markdown is a “mark-up” language. It allows you to write content in plain text that can be easily<br />
|
||
converted to other formats, such as <strong>html, pdf, docx</strong>, and many more. All the articles written on<br />
|
||
this website are written in markdown, here’s an image of this article written in markdown.</p>
|
||
<p><img src="/articles/images/2023-10-21-markdown.png" alt="markdown" /></p>
|
||
<p>The reason you should learn markdown is that it allows you to focus on the content / text of your<br />
|
||
content with simple concepts for formatting. Markdown is used heavily in documenting software<br />
|
||
projects, which is how I got introduced to it, however it can scale all the way up to writing<br />
|
||
research papers or even books.</p>
|
||
<p>I use markdown for probably 80% of all the text documents I need to write, from company documents,<br />
|
||
web / software documentation, and so on. It allows me to get content out quickly without having to<br />
|
||
click around with formatting options in a program like <strong>Word</strong> or <strong>Pages</strong>. To be clear, a lot of<br />
|
||
the reports and things I generate for my <strong>Home Performance Assessments</strong> are written using<br />
|
||
<strong>Pages</strong> (for now at least) because I have templates that make the documents look more<br />
|
||
professional, however I am working on solutions to migrate those to be markdown based.</p>
|
||
<p>Markdown is supported in mostly all the <strong>Google</strong> tools, as well as the <strong>Outlook</strong> email client<br />
|
||
(which is one of my least favorite tools, BTW). It makes it simple to create tables, lists, and many<br />
|
||
common document related tasks.</p>
|
||
<h2>Resources</h2>
|
||
<p>You can learn more about the syntax used for markdown at<br />
|
||
<a href="https://www.markdownguide.org/basic-syntax/">markdownguide.org</a>.</p>
|
||
<h3>A non-exhaustive list of where you can use Markdown and editors.</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Platform</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>Google</td>
|
||
<td>Most goggle tools support markdown, docs, sheets, etc.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Outlook</td>
|
||
<td>Although I hate outlook email client, it does support markdown.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Dillinger.io</td>
|
||
<td>An online tool for writing / previewing markdown</td>
|
||
</tr>
|
||
<tr>
|
||
<td>MarkText</td>
|
||
<td>A multi-platform editor for writing markdown</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>You can use tools such as <a href="https://pandoc.org/#">pandoc</a> to convert Markdown files to other formats.</p>
|
||
<p><img src="/articles/images/2023-10-21-pandoc.gif" alt="pandoc" /></p>
|
||
<h2>Conclusion</h2>
|
||
<p>I hope that you take the time to research and see if Markdown is good fit for your document /<br />
|
||
content creation.</p>
|
||
<p>Thanks for reading until the end!</p>
|
||
</article>
|
||
<div class="border-t border-light mt-8 pt-8">
|
||
<h2 class="text-4xl font-extrabold mb-8">
|
||
Written by
|
||
</h2>
|
||
<div class="flex flex-col lg:flex-row gap-8">
|
||
<div class="flex-[0_0_120px]">
|
||
<img class="w-[120px] h-[120px] rounded-full" src="/static/images/avatar.png"/>
|
||
</div>
|
||
<div class="prose">
|
||
<h3 class="!m-0">
|
||
Michael Housh
|
||
</h3>
|
||
<p class="text-gray">
|
||
HVAC business owner with over 27 years of experience. Writes articles about HVAC,
|
||
Programming, Home-Performance, and Building Science
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="mt-16">
|
||
<h2 class="text-4xl font-extrabold mb-8">
|
||
More articles
|
||
</h2>
|
||
<div class="grid lg:grid-cols-2 gap-10">
|
||
<section>
|
||
<h2 class="text-2xl font-bold mb-2">
|
||
<a class="[&:hover]:border-b border-orange" href="/articles/2025/vapor-htmx-todo-app/">Vapor + HTMX</a>
|
||
</h2>
|
||
<div class="text-gray gray-links text-sm mb-4">
|
||
<span class="border-r border-gray pr-2 mr-2">January 05, 2025</span><a href="/articles/tag/general/">general</a>, <a href="/articles/tag/programming/">programming</a> and <a href="/articles/tag/software/">software</a>
|
||
</div>
|
||
<p>
|
||
<a href="/articles/2025/vapor-htmx-todo-app/"><div>
|
||
<img alt="banner" src="http://localhost:3000/articles/images/2025-01-05-vapor-htmx-todo-app.png"/>
|
||
Build an example application using Vapor and HTMX.
|
||
</div></a>
|
||
</p>
|
||
</section>
|
||
<section>
|
||
<h2 class="text-2xl font-bold mb-2">
|
||
<a class="[&:hover]:border-b border-orange" href="/articles/2024/free-as-in-freedom/">Free As In Freedom</a>
|
||
</h2>
|
||
<div class="text-gray gray-links text-sm mb-4">
|
||
<span class="border-r border-gray pr-2 mr-2">April 09, 2024</span><a href="/articles/tag/general/">general</a>, <a href="/articles/tag/open-source/">open-source</a> and <a href="/articles/tag/software/">software</a>
|
||
</div>
|
||
<p>
|
||
<a href="/articles/2024/free-as-in-freedom/"><div>
|
||
<img alt="banner" src="http://localhost:3000/articles/images/2024-04-09-free-as-in-freedom.png"/>
|
||
Salute to open-source software engineers
|
||
</div></a>
|
||
</p>
|
||
</section>
|
||
</div>
|
||
<p class="prose mt-8">
|
||
<a href="/articles/">› See all articles</a>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="site-footer container text-gray gray-links border-t border-light text-center pt-6 mt-8 text-sm">
|
||
<p>
|
||
Copyright © Michael Housh 2023-2025.
|
||
</p>
|
||
<p>
|
||
Built in Swift using
|
||
<a href="https://github.com/loopwerk/Saga" rel="nofollow" target="_blank">Saga</a>
|
||
(<a href="https://github.com/m-housh/mhoush.com" rel="nofollow" target="_blank">source</a>).
|
||
</p>
|
||
<p>
|
||
<a href="http://localhost:3000/articles/feed.xml" rel="nofollow" target="_blank">RSS</a>
|
||
|
|
||
<a href="https://github.com/m-housh" rel="nofollow" target="_blank">Github</a>
|
||
|
|
||
<a href="https://www.youtube.com/channel/UCb58SeURd5bObfTiL0KoliA" rel="nofollow" target="_blank">Youtube</a>
|
||
|
|
||
<a href="https://www.facebook.com/michael.housh" rel="nofollow" target="_blank">Facebook</a>
|
||
|
|
||
<a href="mailto:michael@mhoush.com" rel="nofollow">Email</a>
|
||
</p>
|
||
</div>
|
||
</body>
|
||
</html> |