Skip to main content
Ctrl+K

Rein's Homepage

Study Note

  • 如何使用 GitHub Pages 以及 Sphinx 套件建立個人網頁
    • 網站架構
    • 網頁架構
    • 常用語法與 Documents
  • (C/C++) 如何在Linux上編譯與使用 static /shared library
  • Jansson (a C library for JSON data) 使用教學
  • Ubuntu 工具安裝
  • Git 學習筆記
    • Git FAQ
    • Git 指令自動補齊
    • 大型專案管理
    • 實用設定
  • Yocto 學習筆記
    • Yocto 基本介紹
    • 如何開始一個 Yocto 專案
    • FAQ
  • Docker Tutorial
  • 專業術語筆記
  • 品牌廠商與相關產品筆記
  • Effective Modern C++ 筆記
    • Introduction
    • Item 1: Understand template type deduction
  • Repository
  • Show source
  • Suggest edit
  • Open issue
  • .md

常用語法與 Documents

Contents

  • 常用語法
    • Admonition
    • Type 列表
    • property 列表
  • Documents
    • Tools
    • Configuration
    • Official site

常用語法與 Documents#

常用語法#

Admonition#

語法如下

1```{<type>}
2:name: <xxx>
3:class: <property>
4...
5
6content
7...
8
9```

Type 列表#

  • attention

  • caution

  • danger

  • error

  • hint

  • important

  • note

  • seealso

  • tip

  • warning

property 列表#

  • dropdown

Documents#

Tools#

  • Admonitions

  • Images and figures

Configuration#

  • MyST

  • MyST-NB

  • sphinx.ext.graphviz

Official site#

  • Sphinx

  • Sphinx-book-theme

  • MyST

  • MyST-NB

previous

網頁架構

next

(C/C++) 如何在Linux上編譯與使用 static /shared library

Contents
  • 常用語法
    • Admonition
    • Type 列表
    • property 列表
  • Documents
    • Tools
    • Configuration
    • Official site

By Rein Wu

© Copyright 2023, Rein Wu.