Owen Young's Blog - MarkdownMainly focus on technology, reading, excerpts, miscellaneous, article review, tool sharing, workflow, inspiration, English learning, attention management, deep work and other directionsZola2022-07-25T10:50:28+08:00https://old.owenyoung.com/en/tags/markdown/atom.xmlSimple bash to generate template markdown file for the initial blog post2022-07-25T10:50:28+08:002022-07-25T00:00:00+00:00
Owen Young
https://old.owenyoung.com/en/blog/simple-bash-to-generate-template-markdown-file-for-the-initial-blog-post/<p>When you’re using markdown to write your blog, you can use the following template to generate a new markdown file, you may use some template like this to generate a new markdown file:</p>
<p>When you’re using markdown to write your blog, you can use the following template to generate a new markdown file, you may use some template like this to generate a new markdown file:</p>
<span id="continue-reading"></span><pre data-lang="yaml" style="background-color:#2b303b;color:#c0c5ce;" class="language-yaml "><code class="language-yaml" data-lang="yaml"><span>---
</span><span style="color:#bf616a;">title</span><span>:
</span><span style="color:#bf616a;">date</span><span>: </span><span style="color:#a3be8c;">${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}T${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}+08:00
</span><span style="color:#bf616a;">updated</span><span>: </span><span style="color:#a3be8c;">${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}
</span><span style="color:#bf616a;">draft</span><span>: </span><span style="color:#d08770;">true
</span><span style="color:#bf616a;">taxonomies</span><span>:
</span><span> </span><span style="color:#bf616a;">categories</span><span>:
</span><span> - </span><span style="color:#a3be8c;">Random
</span><span> </span><span style="color:#bf616a;">tags</span><span>:
</span><span> -
</span><span>---
</span></code></pre>
<p>I used to generate these markdown articles with VSCode extention <a rel="noopener nofollow noreferrer" target="_blank" href="https://marketplace.visualstudio.com/items?itemName=theowenyoung.foam-lite-vscode">foam-lite</a>, which is like this:</p>
<p><img src="https://old.owenyoung.com/en/blog/simple-bash-to-generate-template-markdown-file-for-the-initial-blog-post/./vscode-foam.gif" alt="" /></p>
<p>The problem is that it’s an VSCode extention, not an general tool, and the tool also has a little limitations.
for example, the default generated file path is based on the current directory, so I always need to navigate to the correct directory to generate the markdown file.</p>
<p>And recent days, I started to use <a rel="noopener nofollow noreferrer" target="_blank" href="https://github.com/theowenyoung/dotfiles">Dotfiles</a> to manage all my configuration files, and I used a lot of bash scripts to manage my dotfiles. So why not to use bash scripts to generate the initial markdown files? It’s general enough, and it’s easy to use, and it can be reused in any editors.</p>
<p>Here is the final workflow for creating a daily markdown file:</p>
<p><img src="https://old.owenyoung.com/en/blog/simple-bash-to-generate-template-markdown-file-for-the-initial-blog-post/./bash-daily.gif" alt="" /></p>
<p>Here is the workflow for creating a normal post:</p>
<p><img src="https://old.owenyoung.com/en/blog/simple-bash-to-generate-template-markdown-file-for-the-initial-blog-post/./bash-random.gif" alt="" /></p>
<h2 id="how-to-do-this">How to do this?<a class="zola-anchor" href="#how-to-do-this" aria-label="Anchor link for: how-to-do-this">🔗</a></h2>
<p>I use <a rel="noopener nofollow noreferrer" target="_blank" href="https://github.com/tests-always-included/mo">Bash Mustache</a> as the template engine, it’s simple but powerful, and it’s just a simple bash file, I place it in my blog repo <code>./scripts/mo.sh</code>, then I write an function in <code>./scripts/common.sh</code></p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#65737e;">#!/bin/bash
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_YEAR</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">Y</span><span style="color:#a3be8c;">)
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_MONTH</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">m</span><span style="color:#a3be8c;">)
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_DATE</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">d</span><span style="color:#a3be8c;">)
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_HOUR</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">H</span><span style="color:#a3be8c;">)
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_MINUTE</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">M</span><span style="color:#a3be8c;">)
</span><span style="color:#b48ead;">export </span><span style="color:#bf616a;">CURRENT_SECOND</span><span>=$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">S</span><span style="color:#a3be8c;">)
</span><span>
</span><span style="color:#65737e;"># template functions
</span><span style="color:#b48ead;">function </span><span style="color:#8fa1b3;">template</span><span>() {
</span><span> </span><span style="color:#bf616a;">template_path</span><span>="$</span><span style="color:#bf616a;">1</span><span>"
</span><span> </span><span style="color:#bf616a;">target_path</span><span>="$</span><span style="color:#bf616a;">2</span><span>"
</span><span> </span><span style="color:#bf616a;">target_dir</span><span>="$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">dirname </span><span>$</span><span style="color:#bf616a;">target_path</span><span style="color:#a3be8c;">)</span><span>"
</span><span> </span><span style="color:#65737e;"># check target dir is exist, if not, create it
</span><span> </span><span style="color:#b48ead;">if </span><span style="color:#96b5b4;">[ </span><span>! </span><span style="color:#bf616a;">-d </span><span>"$</span><span style="color:#bf616a;">target_dir</span><span>" </span><span style="color:#96b5b4;">]</span><span>; </span><span style="color:#b48ead;">then
</span><span> </span><span style="color:#bf616a;">mkdir -p </span><span>$</span><span style="color:#bf616a;">target_dir
</span><span> </span><span style="color:#b48ead;">fi
</span><span>
</span><span> </span><span style="color:#65737e;"># check target file is exists
</span><span> </span><span style="color:#b48ead;">if </span><span style="color:#96b5b4;">[ </span><span style="color:#bf616a;">-f </span><span>$</span><span style="color:#bf616a;">target_path </span><span style="color:#96b5b4;">]</span><span>; </span><span style="color:#b48ead;">then
</span><span> </span><span style="color:#96b5b4;">echo </span><span>"$</span><span style="color:#bf616a;">target_path</span><span style="color:#a3be8c;"> file exists</span><span>"
</span><span> </span><span style="color:#96b5b4;">exit</span><span> 1
</span><span> </span><span style="color:#b48ead;">fi
</span><span> </span><span style="color:#bf616a;">cat </span><span>$</span><span style="color:#bf616a;">template_path </span><span>| </span><span style="color:#bf616a;">./scripts/mo.sh </span><span>> $</span><span style="color:#bf616a;">target_path
</span><span> </span><span style="color:#96b5b4;">echo </span><span>"$</span><span style="color:#bf616a;">target_path</span><span style="color:#a3be8c;"> created!</span><span>"
</span><span>}
</span></code></pre>
<p>For daily journal article(<code>./scripts/daily.sh</code>):</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#65737e;">#!/bin/bash
</span><span style="color:#96b5b4;">source</span><span> ./scripts/common.sh
</span><span style="color:#bf616a;">template_path</span><span>="</span><span style="color:#a3be8c;">./scripts/templates/daily.md.tmpl</span><span>"
</span><span style="color:#bf616a;">target_path</span><span>="</span><span style="color:#a3be8c;">./content/blog/journals/</span><span>$</span><span style="color:#a3be8c;">(</span><span style="color:#bf616a;">date</span><span style="color:#a3be8c;"> +</span><span>%</span><span style="color:#bf616a;">Y</span><span style="color:#a3be8c;">-</span><span>%</span><span style="color:#bf616a;">m</span><span style="color:#a3be8c;">-</span><span>%</span><span style="color:#bf616a;">d</span><span style="color:#a3be8c;">).md</span><span>"
</span><span>
</span><span style="color:#bf616a;">template </span><span>$</span><span style="color:#bf616a;">template_path </span><span>$</span><span style="color:#bf616a;">target_path</span><span>;
</span><span style="color:#bf616a;">code </span><span>$</span><span style="color:#bf616a;">target_path</span><span>;
</span></code></pre>
<p>This script will create a file named <code>./content/blog/journals/2022-07-25.md</code> with the <code>./scripts/templates/daily.md.tmpl</code> template:</p>
<pre data-lang="bash" style="background-color:#2b303b;color:#c0c5ce;" class="language-bash "><code class="language-bash" data-lang="bash"><span style="color:#bf616a;">---
</span><span style="color:#bf616a;">title: </span><span>{{CURRENT_YEAR}}-{{CURRENT_MONTH}}-{{CURRENT_DATE}}的各种链接
</span><span style="color:#bf616a;">date: </span><span>{{CURRENT_YEAR}}-{{CURRENT_MONTH}}-{{CURRENT_DATE}}T{{CURRENT_HOUR}}:{{CURRENT_MINUTE}}:{{CURRENT_SECOND}}+08:00
</span><span style="color:#bf616a;">updated: </span><span>{{CURRENT_YEAR}}-{{CURRENT_MONTH}}-{{CURRENT_DATE}}
</span><span style="color:#bf616a;">draft:</span><span> false
</span><span style="color:#bf616a;">taxonomies:
</span><span> </span><span style="color:#bf616a;">categories:
</span><span> </span><span style="color:#bf616a;">-</span><span> Journal
</span><span> </span><span style="color:#bf616a;">tags:
</span><span> </span><span style="color:#bf616a;">-</span><span> Journal
</span><span style="color:#bf616a;">---
</span></code></pre>
<p>For convinient to use, I also add a alias in <code>Makefile</code>:</p>
<pre data-lang="Makefile" style="background-color:#2b303b;color:#c0c5ce;" class="language-Makefile "><code class="language-Makefile" data-lang="Makefile"><span style="color:#8fa1b3;">.Phony</span><span>: </span><span style="color:#a3be8c;">daily
</span><span style="color:#8fa1b3;">daily</span><span>:
</span><span> </span><span style="color:#bf616a;">./scripts/daily.sh
</span></code></pre>
<p>So if I want to generate a new daily article, I just need to run <code>make daily</code></p>
<p>Or, If I’m in VSCode, I created a task for VSCode in <code>.vscode/tasks.json</code>:</p>
<pre data-lang="json" style="background-color:#2b303b;color:#c0c5ce;" class="language-json "><code class="language-json" data-lang="json"><span>{
</span><span> "</span><span style="color:#a3be8c;">version</span><span>": "</span><span style="color:#a3be8c;">2.0.0</span><span>",
</span><span> "</span><span style="color:#a3be8c;">tasks</span><span>": [
</span><span> {
</span><span> "</span><span style="color:#a3be8c;">label</span><span>": "</span><span style="color:#a3be8c;">daily</span><span>",
</span><span> "</span><span style="color:#a3be8c;">type</span><span>": "</span><span style="color:#a3be8c;">shell</span><span>",
</span><span> "</span><span style="color:#a3be8c;">command</span><span>": "</span><span style="color:#a3be8c;">make daily</span><span>",
</span><span> "</span><span style="color:#a3be8c;">presentation</span><span>": {
</span><span> "</span><span style="color:#a3be8c;">reveal</span><span>": "</span><span style="color:#a3be8c;">silent</span><span>",
</span><span> "</span><span style="color:#a3be8c;">close</span><span>": </span><span style="color:#d08770;">true
</span><span> }
</span><span> },
</span><span> {
</span><span> "</span><span style="color:#a3be8c;">label</span><span>": "</span><span style="color:#a3be8c;">random</span><span>",
</span><span> "</span><span style="color:#a3be8c;">type</span><span>": "</span><span style="color:#a3be8c;">shell</span><span>",
</span><span> "</span><span style="color:#a3be8c;">command</span><span>": "</span><span style="color:#a3be8c;">./scripts/random.sh ${input:filename}</span><span>",
</span><span> "</span><span style="color:#a3be8c;">presentation</span><span>": {
</span><span> "</span><span style="color:#a3be8c;">reveal</span><span>": "</span><span style="color:#a3be8c;">silent</span><span>",
</span><span> "</span><span style="color:#a3be8c;">close</span><span>": </span><span style="color:#d08770;">true
</span><span> }
</span><span> },
</span><span> {
</span><span> "</span><span style="color:#a3be8c;">label</span><span>": "</span><span style="color:#a3be8c;">notes</span><span>",
</span><span> "</span><span style="color:#a3be8c;">type</span><span>": "</span><span style="color:#a3be8c;">shell</span><span>",
</span><span> "</span><span style="color:#a3be8c;">command</span><span>": "</span><span style="color:#a3be8c;">./scripts/notes.sh ${input:filename}</span><span>",
</span><span> "</span><span style="color:#a3be8c;">presentation</span><span>": {
</span><span> "</span><span style="color:#a3be8c;">reveal</span><span>": "</span><span style="color:#a3be8c;">silent</span><span>",
</span><span> "</span><span style="color:#a3be8c;">close</span><span>": </span><span style="color:#d08770;">true
</span><span> }
</span><span> },
</span><span> {
</span><span> "</span><span style="color:#a3be8c;">label</span><span>": "</span><span style="color:#a3be8c;">book</span><span>",
</span><span> "</span><span style="color:#a3be8c;">type</span><span>": "</span><span style="color:#a3be8c;">shell</span><span>",
</span><span> "</span><span style="color:#a3be8c;">command</span><span>": "</span><span style="color:#a3be8c;">./scripts/book.sh ${input:filename}</span><span>",
</span><span> "</span><span style="color:#a3be8c;">presentation</span><span>": {
</span><span> "</span><span style="color:#a3be8c;">reveal</span><span>": "</span><span style="color:#a3be8c;">silent</span><span>",
</span><span> "</span><span style="color:#a3be8c;">close</span><span>": </span><span style="color:#d08770;">true
</span><span> }
</span><span> }
</span><span>
</span><span> ],
</span><span> "</span><span style="color:#a3be8c;">inputs</span><span>": [
</span><span> {
</span><span> "</span><span style="color:#a3be8c;">type</span><span>": "</span><span style="color:#a3be8c;">promptString</span><span>",
</span><span> "</span><span style="color:#a3be8c;">id</span><span>": "</span><span style="color:#a3be8c;">filename</span><span>",
</span><span> "</span><span style="color:#a3be8c;">description</span><span>": "</span><span style="color:#a3be8c;">You article path.</span><span>",
</span><span> "</span><span style="color:#a3be8c;">default</span><span>": "",
</span><span> }
</span><span> ]
</span><span>}
</span></code></pre>
<p>All source codes are in my blog <a rel="noopener nofollow noreferrer" target="_blank" href="https://github.com/theowenyoung/blog">repo</a></p>