Rust製サーバーとVuePressで構築するモダンな公式ドキュメントサイト

ドキュメントサイトの設計方針カスタマイズ性が高く、かつ迅速に構築可能な公式ウェブサイトの設計を目指します。技術ドキュメントのホスティングを主目的としつつ、ブログ機能なども柔軟に組み込めるアーキテクチャを採用します。静的サイトジェネレーターの選定当初はブログプラットフォームとしてVanBlogを検討しましたが、公式サイトの用途には静的サイトジェネレータ ...

10月15日 09:56 投稿

Markdown 構文と拡張機能の実装ガイド

Markdown 編集環境と構文検証 Markdown 文書において、異なる特殊プレースホルダーが占有する空白サイズは異なります。 【1】または // 全角空白 【2】または // 半角空白 【3】または // 半角のさらに半角 目次構造 段落内に [TOC] を記述することで、文書全体の目次構造を自動生成できます。 目次プレビュー 特殊プレースホルダーの空白差異 目次構造 M ...

9月9日 00:50 投稿

Mermaidによるフローチャートの詳細な使い方

1. Mermaidの概要 Mermaidはテキストベースの軽量な図表作成ツールであり、開発者や技術専門職がシンプルな記述で図を生成できるように設計されています。複雑なグラフィックエディタを使用せず、コードのようにバージョン管理可能な方法で図を作成できます。 このツールは2014年にKnut Sveidqvistによって開発され、ドキュメントに保守性のある図を埋め込むという課題を解 ...

5月18日 13:15 投稿