ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Markdownを開発現場で使っていると、ドキュメントの一部を使い回したくなります。HTMLなのでリンクでもいいのですが、可読性を高めるなら同じ内容であっても書いてある方が分かりやすいです。

そうしたニーズに対応できるのがgenです。Markdownでテンプレート化できるライブラリです。

genの使い方

genでは次のように記述します。import元を外部ファイルなどで指定できます。

---
layout: layout/index.html
author: Atsushi
a:
  import:
  - content/another.md
---

This page is written by {{ .author }}

Another page was written by {{ .a.author }}

こちらはインポート元になります。

---
author: Anonymous Gopher
---

生成されるHTMLです。

genはレイアウトのHTMLファイルと、そのコンテンツを別途Markdownファイルで作成します。一部のコンテンツをシステムから取得するようにすれば、自動更新されるドキュメントにもできるでしょう。Markdownを多用する際に便利そうです。

genはGo製のオープンソース・ソフトウェア(MIT License)です。

Qs-F/gen: cmd gen is a tool to output static htmls from markdowns with import feature for other markdown..

 

MOONGIFTの関連記事

  • DevRel
  • Com2