Future Tech Blog
フューチャー技術ブログ
Home
Tags
Markdown
Markdown
タグの記事
4
投稿
3
著者数
349
総シェア数
25
Twitter
0
Facebook
200
はてブ
124
Pocket
パーサーコンビネータをもっと身近にする
生成AIが人気です。生成AIに対しては自然言語で指示を与えられますが、自然言語を構造化してやりとりする方法としてはよくMarkdownが使われます。その生成AIフレンドリーなMarkdownで設計ドキュメントを作るとしても...
2024.08.19
パーサーコンビネータ
Markdown
Go言語
goldmark
ツイート
シェア
3
6
markdownlintで設計書の品質を高める
Markdownで設計書を充実させようとすればするほど、設計書間やメンバー間のちょっとした揺れで、本質的なレビューがしにくく感じるようになりました。そこでMarkdownのLintツールを導入するモチベーションが高まりました。
2023.04.17
Markdown
Linter
ドキュメント
Markdownlint
ツイート
シェア
185
106
Next.js公式のMDXプラグインで、Markdownでページを作る機能を試してみた
お客様と一緒にNext.jsのドキュメントの輪読会をやっているのですが、その中で初めて知った機能がMDXというマークダウンでページを作成する機能です。https://nextjs.org/docs/advanced-features/using-mdx利用規約とか、プライバシーポリシーのページ、ヘルプページの作成とか、Reactコンポーネントも表示できるので、Storybookがわりのコンポーネントカタログを作るのに便利そうという話になったので、ちょっと試してみました。
2022.08.16
Markdown
フロントエンド
Next.js
MDX
25
シェア
8
8
CircleCIでMarkdownのリンク切れを自動検知する
私のチームでは、「システムの設計情報」や「実装に関わる業務知識」などを、`README.md` に整理して GitHub 管理しています。設計資料や業務系のドキュメントが蓄積され、何度も更新され続けることに伴い、「あれ、この資料のリンクが切れてる。オリジナルのファイルはどこだっけ?」と探す機会が増えてきました。本来ならば PullRequest のレビュー時に気付くべきですが、ファイル名のちょっとしたスペルミスや資料パスの変更などだと、目視でのチェックには限界があります。
2021.04.22
Markdown
ドキュメント
CircleCI
ツイート
シェア
4
4
1