Skip to content

組み込みエンジニア養成講座へようこそ

このテキストは以下のようなシステムを使用して製作されています

メール連絡先:j-kikuchiあっとまーくeyes-tokyo.com


作成環境

ツール 内容 説明 補足  参考URL
Vscode 文書作成 Markdown形式の文書を作成しています マイクロソフト製のIT業界標準のテキストエディターです
Markdown Preview Mermaid Support Markdown文書に各種の図を埋め込みます vscodeの拡張機能  URL
markdownlint lint Markdown形式の文書の書式をチェック
Draw.io Integration 図の作成 - vscodeの拡張機能 -

図表作成自体の詳細は以下公式リンクから参照してください

Mermaid Diagramming

Draw.io


配布するための変換mkdocs

markdownファイルからHTMLを生成してくれます

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

1
2
3
4
mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.