Docs

  • WSOFT Docs
  • あみうは
    • あみうは
    • 新学期が始まりました!
    • 恋の相談
    • プチコン3号で作ったのは?
    • オススメの文庫
    • マクドナルド最高!
    • ios11β レビュー
    • あみうはの歌について
    • ついに自分のソフトウェアのホームページができました。
    • Windowsタブレットをリセットして起動しなくなった人のために
    • PCレスで YouTubeの曲を携帯mp3プレイヤーで聴く(iPhone)
    • 食べられないラズベリーパイを買いました。(1)
    • ラズベリーパイの下ごしらえ(2)
    • 小説始めます~
    • 女子がキュンとくる行動ベスト3!!
    • MacとWindowsについてあまり知られていない事
    • macでできる裏技
    • ドコモの格安スマホ「MONO」買っちゃいました☆いい所をいくつか
    • 『レビュー』iPhone6sを1年間使い続けて思ったこと
    • iPhoneの拡大鏡に関するバクを発見しました。
    • iPhoneで圧縮ファイルを作成したり解凍する方法
    • Obscura2が今だけ無料!使い方まとめ
    • Windowsタブレットがブルースクリーンになった時のメモ
    • お知らせ
      • あみうはからのお知らせ
      • あみうは ブログ始めました。
      • 予告 web ページの更新について 🇯🇵ver 2.0.0.jp Deep Space 🇺🇸ver 2.0.0 Deep Space
      • あみうはショップから大切なお知らせ
      • みんなの投稿サービス終了のお知らせ
      • あけましておめでとうございます
      • あみうはホームページをアップデートしました。
      • あみうは はついに1周年を迎えました!!1年間を振り返ります!
      • あみうはダウンロードの閉鎖について
      • 特定商取引法に基づく表記
      • あみうは系サイトの閉鎖について
  • ブログ
    • ブログ
    • WSOFT AdventWeek 2022のお知らせ
    • DiscordのBotは多重人格の夢を見るか?
    • WSOFTのアイコンを入手する
    • WSOFTDocs へようこそ
    • WSOFTの製品の一覧
    • wsoft.wsへのドメイン移行に関する情報
    • WSOFTのロゴ変更に関する情報
    • WSOFTのドキュメントの WSOFT Docs への移行に関する情報
    • Raspberry Pi初代やZeroでAliceScriptを実行する
    • Losetta0.9.16に更新した後のエラーを直す
    • WSOFT AdventWeekへようこそ
  • 共同作成ガイド
    • 概要
    • コントリビュータ行動規範
    • リンクの使い方
    • Markdownリファレンス
    • メタデータ
    • テキストの書式設定に関する指針
  • 法的資料
    • 法的資料
    • Alice-EULA-R
    • WSOFT-EULA
    • WSTube エンドユーザー利用規約
    • あみうは利用規約
    • WSOFTダウンロードセンター利用規約
    • 使用条件
  • 製品
    • 製品
    • PCMX
      • ブートローダーメニューの使い方
    • WSOFTアカウント
      • WSOFTアカウントの概要
      • WebからWSOFTアカウントにログインする
      • WindowsアプリからWSOFTアカウントにログインする
      • WSOFTオンライン手続きの概要
    • AliceScript
      • AliceScript
      • 謝辞
      • ダウンロード
      • Alice(キャラクター)
      • AliceScriptのツアー
      • Wikiの概要
      • APIブラウザー
        • APIブラウザー
        • Alice
          • delay
          • exit
          • function
          • import
          • include
          • lock
          • print
          • string_format
          • using
          • write
          • Environment
            • env_commandLine
            • env_commandLineArgs
            • env_set_exitCode
            • env_hasshutdownstarted
            • env_Is64BitOperatingSystem
            • env_Is64BitProcess
            • env_MachineName
            • env_NewLine
            • env_os_platform
            • env_os_version
          • Exception
            • Exception
            • ErrorCode
            • Message
            • ToString
          • Interpreter
            • Type
              • Type
              • Activate
              • Base
              • IsObject
              • Namespace
              • ToNativeProperty
              • ToString
          • Math
            • math_abs
            • math_acos
            • math_acosh
            • math_atan
            • math_atan2
            • math_atanh
            • math_bitdecrement
            • math_bitincrement
            • math_cbrt
            • math_celling
            • math_clamp
            • math_copysign
            • math_cos
            • math_cosh
            • math_e
            • math_exp
            • math_floor
            • math_fusedmultiplyadd
            • math_isprime
            • math_max
            • math_min
            • math_pi
            • math_pow
            • math_round
            • math_sin
            • math_sinh
            • math_sqrt
            • math_tan
            • math_tanh
            • math_tau
            • math_truncate
          • Net
            • web_download_file
            • web_download_file
            • web_download_text
            • web_htmldecode
            • web_htmlencode
            • web_send_ping
            • web_upload_data
            • web_upload_file
            • web_upload_text
            • web_urldecode
            • web_urlencode
          • Security
            • password_hash
            • password_hash_data
            • password_salt
            • password_verify
            • password_verify_data
          • Threading
            • signal
            • signal_wait
            • task_run
            • thread_id
            • thread_queue
        • Array
          • array
          • Add
          • AddRange
          • All
          • Any
          • Contains
          • Distinct
          • Except
          • First
          • Flatten
          • Foreach
          • IndexOf
          • Insert
          • InsertRange
          • Intersect
          • Last
          • Length
          • Merge
          • OfType
          • OrderBy
          • OrderByDescending
          • Remove
          • RemoveAt
          • RemoveRange
          • Reverse
          • Select
          • SequenceEqual
          • Size
          • Skip
          • SkipWhile
          • Sort
          • Take
          • TakeWhile
          • Union
          • Where
        • Bool
          • bool
        • Bytes
          • bytes
        • Delegate
          • delegate
          • BeginInvoke
          • Invoke
        • None
          • none
        • Number
          • number
        • String
          • string
          • CompareTo
          • Contains
          • EndsWith
          • Format
          • IndexOf
          • Insert
          • IsEmptyOrNull
          • IsEmptyOrWhite
          • IsNormalized
          • Join
          • LastIndexOf
          • Normalize
          • PadLeft
          • PadRight
          • Remove
          • RemoveAt
          • Replace
          • Split
          • StartsWith
          • SubString
          • ToLower
          • ToLowerInvariant
          • ToUpper
          • ToUpperInvariant
          • Trim
          • Trim
          • TrimStart
        • Variable
          • variable
          • Clone
          • Convert
          • DeepClone
          • Dispose
          • Equals
          • Properties
          • ToString
          • Type
      • 変更履歴
        • 新機能の一覧
        • AliceScript GoldenMasterの新機能
        • AliceScript 2.1の新機能
        • AliceScript 2.2の新機能
        • 互換性に影響を与える変更点
        • Nightyビルドの変更履歴
        • AliceScript RC2の新機能
        • Losetta
          • Losettaの更新履歴
          • Losetta 0.9.15
          • Losetta 0.9.16
          • Losetta 0.9.17
          • Losetta 0.9.18
          • Losetta 0.9.19
          • Losetta 0.9.20
      • 基本
        • 基本
        • AliceScript ADK
        • AlicePackage
        • AliceSister
        • AliceSister
        • AliceScriptのコーディング規約
        • イベント
        • 例外
        • 式
        • 前処理指令
        • AliceModel
        • 変数
      • Alice in Discord
        • Alice in Discordの紹介
        • Alice in Discordの基礎
        • Alice in Discord コミュニティガイドライン
        • Alice in Discordに関連するプロジェクトの一覧
      • 相互運用
        • 基本的なAliceScriptライブラリの開発
      • チュートリアル
        • チュートリアル
        • 初めてのAliceScript
        • パッケージのビルド
        • 数値型の計算誤差
        • 自分自身の関数を取得する
        • AlicePackageの関連付け
        • WSOFTScriptからの移行
        • AliceScriptで安全にパスワードを保存する
        • Losettaを更新する
    • ダウンロードセンター
      • WSOFTダウンロードセンターの概要
      • API
      • 検索
      • マネージャー
        • WSOFTダウンロードセンターマネージャーの概要
        • 更新履歴
          • WSOFTダウンロードセンター管理端末の更新情報
          • バージョン50
          • バージョン53
    • ほめて.ws
      • ほめて.wsの概要
    • アイコンメーカー
      • アイコンメーカーの概要
    • WSOFTScript
      • WSOFTScript
      • WSOFTScript 0.07 R3
      • WSOFTScript 0.07 R4
      • WSOFTScript 2020 LTSの情報
      • WSOFTScriptのライフサイクル
      • 使用されているLosettaのバージョンを確認する
      • WSOFTScript Pocket 2020 Beta
      • Shangri-la 0.07 R4
      • Shangri-la 2020 LTS
    • Unidet
      • Unidetへようこそ
    • WebSailing
      • WebSailing
      • 謝辞
      • APIブラウザー
      • 更新履歴
        • WebSailingNXの更新情報
        • NX 83
        • NX 104.1
        • NX 105
        • NX 105.1
        • NX 106
        • NX 106.1
        • NX 106.2
        • NX 107
        • NX 107.1
        • NX 107.2
        • NX 108
        • NX 109
        • NX 110
        • NX 110.1
        • NX 110.2
        • NX 110.3
        • NX 111
      • GL
        • WebSailingの仕様について(GL系のみ)
        • 更新履歴
          • WebSailingGLの更新情報
          • 1.5.01
          • 1.5.02
          • 1.5.03
          • 1.5.04
          • 1.5.05
          • 1.5.06
          • 2.0
          • 2.1
          • 3.0
          • 20Edition
        • ガイド
          • WebSailingGLプロンプトリファレンス
          • エラーコードE001
          • エラーコードE002
          • エラーコードE003
          • エラーコードU001
          • エラーコードU002
          • WebSailingGLで特定のUrlをブロックする方法
          • WebSailingを更新する方法
          • WebSailingヘルプ
          • WebSailingのコンポーネント変更についてのお知らせ
          • WebSailingプロンプトを極める!その1 API を極める
      • NX(レガシー)
        • WebSailingNX(レガシー)
        • 更新履歴
        • 開発者向け
          • サービス終了後も拡張機能を実行する方法
          • プラグインからSafeBrowsingAPIを呼び出す
          • プラグインガードの概要
        • ガイド
          • WebSailingNXターミナルリファレンス
          • PlusLibraryでライブラリエラー500が発生する場合
          • 認識エラーM300が発生する場合
          • WebSailingのキャッシュを削除する
          • 全画面表示を使う方法
          • WebSailingヘルプ
          • WIWで、NXツールを使う
          • おまけ
          • 捕捉されなかった例外が発生しましたと表示される場合
        • PlusLibrary
          • WSTubeMOD
          • 携帯電話モード
          • 郵便番号検索
      • チュートリアル
        • チュートリアル
        • 起動時に使用される設定を構成する
        • 設定が原因で起動できないと考えられる場合の対処方法
        • WebSailingのWindows7/8.1 Server2012/R2のサポート終了に関するお知らせ
        • AliceScriptを使ってWebSailingを制御する
    • WSNET
      • WSNET
      • WSNETの概要
      • ニュース
        • ニュース
        • WSNET/WAN DHCP機能提供開始
        • WSOFTダウンロードセンターマネージャー v42リリース
        • WSNETDocs提供開始
        • WSOFTダウンロードセンターマネージャーのWSOFTダウンロードセンターマネージャーDocsへの移行に関するお知らせ
      • チュートリアル
        • チュートリアル
        • SoftEtherを使用してWSWANに接続する
        • OpenVPNを使用してWSWANに接続する
        • 証明書のインストール
    • WSTodon
      • WSTodonの概要
      • よくある質問と回答
    • WSTube
      • WSTubeの紹介
      • クレジット
      • WSTube ユーザーガイド
      • お知らせ
        • WSTube NEXTの紹介
        • WSTube NEXT Procyonの紹介
        • WSTube NEXT October’2019の紹介
    • Lantana
  • 生存報告
    • 生存報告
    • 22年度1学期
      • 生存報告
      • イントロダクション
      • おやすみ。
      • 生存報告
      • つながり
      • 生存報告論
      • その一言で、
      • 信じるということ
      • またね。
    • 22年度2学期
      • やさしさ
      • 心の城
      • 勤労感謝の日
      • 自分のことを助けられるのは自分しかいない
      • 大丈夫は大丈夫じゃない
      • おしごと
      • 大きなものは無視できない
      • 石ころの唄
      • 表裏一体
目次
  • 普通のテキスト
  • エスケープ
  • 明示的な空行
  • コメント
  • 見出し
  • テキストの装飾
  • コードブロック
  • 数式
  • 順序なしリスト
  • 番号付きリスト
  • タスクリスト
  • 水平線
  • URL
  • リンク
  • タイトル付きリンク
  • リンクの使いまわし
  • ボタン
  • 画像
  • 表
  • 引用
  • 図形
  • アラート
  • 記事一覧
  • スニペットの埋め込み
  • HTMLの埋め込み
  • 属性の追加

Markdownリファレンス

  1. WSOFTDocs
  2. 共同作成ガイド
  3. Markdownリファレンス

この記事では、WSOFTDocsを執筆する際に必要なマークダウン記法を表します。


たい | 2022-12-01

Markdown記法は、簡単で軽量なマークアップ言語です。WSOFTDocsでは、Jinja解析エンジンを介して解析されます。

普通のテキスト

そのまま記述可能です。

Markdown
Lantanaは、シンプルで軽量なMKDocsのテーマです。
HTMLの知識がなくても簡単にサイトを作成できます。

改行するには、一行空行を挟みます。
結果

Lantanaは、シンプルで軽量なMKDocsのテーマです。 HTMLの知識がなくても簡単にサイトを作成できます。

改行するには、一行空行を挟みます。

エスケープ

マークダウンで意味のある文字(たとえば、*や#など)をテキストとして表示するには、エスケープが必要です。

Markdown
\*\#\!\`\\

結果

*#!`\

明示的な空行

二行以上にわたって改行したい場合など、一部の場合ではHTMLの<br/>タグを使用します。

Markdown
<br/>

コメント

記事にコメントを記述する方法はHTMLと同じです。ビルド時に削除されます。

Markdown
<!-- this is a comment. -->

見出し

Hタグを生成します。記事にタイトルが指定されていない場合、自動的に記事の一番最初の見出しがタイトルになります。

また、見出しは目次にも表示されます。

Markdown
# これはH1タグになります
## これはH2タグになります
###### これはH6タグになります
結果

これはH1タグになります

これはH2タグになります

これはH6タグになります


テキストの装飾

文章を様々に装飾する方法をまとめて紹介します。

Markdown
_ か * で囲むとHTMLのemタグになり、 *このように* 表示されます。

__ か ** で囲むとHTMLのstrongタグになり、**このように** 表示されます。

それらを組み合わせることもできます。*** で囲むと、***このように*** 表示されます。

~~ で囲むと打消し線になり、 ~~このように~~ 表示されます。

^^ で囲むと下線がつき、^^このように^^ 表示されます。

== で囲むとハイライトがつき、==このように== 表示されます。

~ で囲むと下付き文字になり、使用すると~このように~表示されます。

^ で囲むと上付き文字になり、使用すると^このように^表示されます。

++ で囲むと++ctrl+alt+del++のようにキーボードのキーを表現できます。

また、`print("Hello,World!");`と記述することでコードをインライン表示できます。
_ か * で囲むとHTMLのemタグになり、 このように 表示されます。

__ か ** で囲むとHTMLのstrongタグになり、このように 表示されます。

それらを組み合わせることもできます。*** で囲むと、このように 表示されます。

~~ で囲むと打消し線になり、 このように 表示されます。

^^ で囲むと下線がつき、このように 表示されます。

== で囲むとハイライトがつき、このように 表示されます。

~ で囲むと下付き文字になり、使用するとこのように表示されます。

^ で囲むと上付き文字になり、使用するとこのように表示されます。

++ で囲むとCtrl+Alt+Delのようにキーボードのキーを表現できます。

また、print("Hello,World!");と記述することでコードをインライン表示できます。

テキストの装飾について詳しく知るには、テキストの書式設定に関する指針を参照してください。

コードブロック

``` で囲むことでコードとして認識され、初めを```言語名 とすることでシンタックスハイライトがつきます。title="タイトル"とすることでファイル名なども表現できます。また、linenums="1"とすると行番号を表示できます。

Markdown
``` csharp title="Program.cs" linenums="1"
using System;

public class Program
 {
    public static void Main()
     {
            Console.WriteLine("Hello World!");
     }
 }

結果

Program.cs
1
2
3
4
5
6
7
8
9
using System;

public class Program
 {
    public static void Main()
     {
            Console.WriteLine("Hello World!");
     }
 }

注意

上記のサンプルでは末尾の```が欠落しています。(マークダウンの制約)コピペで使用する際はご注意ください。

数式

\$\$で囲むことでTeX記法を用いて数式を記述できます。

Markdown
$$
\operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}}
$$
結果

\[ \operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}} \]

$または\(...\)で囲むことで、数式を文中に埋め込むこともできます。

Markdown
ディッフィー・ヘルマン鍵共有プロトコルでは、まず大きな素数 ${\displaystyle p}p$ と、
${\displaystyle p-1}p-1$ を割り切る大きな素数 ${\displaystyle q}q$ を用意します。
また、 ${\displaystyle g}g$ を
${\displaystyle ({\mathbb {Z} }/p{\mathbb {Z} })^{\ast }}{\displaystyle ({\mathbb {Z} }/p{\mathbb {Z} })^{\ast }}$ の元で、
位数が ${\displaystyle q}q$ である値とします。
この ${\displaystyle p,q,g}{\displaystyle p,q,g}$ の値は公開されているものとします。
結果

ディッフィー・ヘルマン鍵共有プロトコルでは、まず大きな素数 \({\displaystyle p}p\) と、 \({\displaystyle p-1}p-1\) を割り切る大きな素数 \({\displaystyle q}q\) を用意します。また、 \({\displaystyle g}g\) を \({\displaystyle ({\mathbb {Z} }/p{\mathbb {Z} })^{\ast }}{\displaystyle ({\mathbb {Z} }/p{\mathbb {Z} })^{\ast }}\) の元であり、位数が \({\displaystyle q}q\) である値とします。この \({\displaystyle p,q,g}{\displaystyle p,q,g}\) の値は公開されているものとします。

順序なしリスト

リストの上には空行が必要です。

Markdown
* 文頭に"*"、"+"、"-"のいずれかを入れると順序なしリストになります
+ 記号のあとには**スペースが必要**です
- 同じリストでは同じ記号を使うことを推奨します。
結果

  • 文頭に"*"、"+"、"-"のいずれかを入れると順序なしリストになります
  • 記号のあとにはスペースが必要です
  • 同じリストでは同じ記号を使うことを推奨します。

番号付きリスト

リストの上には空行が必要です。

Markdown
1. 文頭に"数字."を入れると番号付きリストになります。
1. "数字."のあとには**スペースが必要**です
1. すべての数字を1にすると、自動的に番号が付きます。
結果

  1. 文頭に"数字."を入れると番号付きリストになります。
  2. "数字."のあとにはスペースが必要です
  3. すべての数字を1にすると、自動的に番号が付きます。

タスクリスト

順序なしリストの記述の後ろに[ ]を入れるとチェックボックスが生成されます。 また、チェックが入った状態のボックスを生成する場合は[x]を入力します。

Markdown
- [ ] タスク1
- [x] タスク2
結果

  • タスク1
  • タスク2

水平線

Markdown
---
結果


URL

Urlやメールアドレスを書くだけで、自動的にリンクになります。

Markdown
https://lantana.wsoft.ws

[email protected]
結果

https://lantana.wsoft.ws

[email protected]

リンク

Markdown
[リンク](about:blank)
結果

リンク

WSOFTDocsでのリンクのお作法については、リンクの使い方を参照してください。

タイトル付きリンク

タイトルはリンクをホバーした時に表示されます。

Markdown
[リンク](about:blank "タイトル")
結果

リンク

リンクの使いまわし

Markdown
[link]: about:blank
[ここ][link]と[ここ][link]は同じになります。
結果

こことここは同じになります。

また、linkという書き方もできます。

ボタン

ボタンを使えば、ユーザーにとって注意を引きやすいリンクを作ることができます。ボタンはBootstrapによって提供されているため、クラスを指定するだけで使用できます。次に例を示します。

Markdown
[ボタン](#){: .btn .btn-primary }
[ボタン](#){: .btn .btn-secondary }
[ボタン](#){: .btn .btn-success }
[ボタン](#){: .btn .btn-danger }
[ボタン](#){: .btn .btn-warning }
[ボタン](#){: .btn .btn-info }
[ボタン](#){: .btn .btn-light }
[ボタン](#){: .btn .btn-dark }
[ボタン](#){: .btn .btn-link }

結果

ボタン ボタン ボタン ボタン ボタン ボタン ボタン ボタン ボタン

画像

Markdown
![代替テキスト](/favicon.png)

結果

代替テキスト

表

Bootstrapの制約により、ヘッダーでは左右中央揃えが適用されません

Markdown
| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       | This        | This         |
| column     | column      | column       |
| will       | will        | will         |
| be         | be          | be           |
| left       | right       | center       |
| aligned    | aligned     | aligned      |

結果

Left align Right align Center align
This This This
column column column
will will will
be be be
left right center
aligned aligned aligned

引用

Markdown
> 文頭に>を置くことで引用になります。
> 複数行にまたがる場合、改行のたびにこの記号を置く必要があります。
> 
> 引用の中に別のMarkdownを使用することも可能です。
> 
> > これはネストされた引用です。
結果

文頭に>を置くことで引用になります。 複数行にまたがる場合、改行のたびにこの記号を置く必要があります。

引用の中に別のMarkdownを使用することも可能です。

これはネストされた引用です。

図形

Lantanaは規定でmermaid.jsをサポートします。mermaid.jsを使うと、複雑な図形を簡単に挿入できます。

Markdown
```mermaid
graph LR;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

結果

graph LR; A-->B; A-->C; B-->D; C-->D;

アラート

目を引く形で説明したい場合、!!! 種類 "タイトル"で囲みます。

Markdown
!!! note "メモ"
    `note`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
結果

メモ

noteで使用できる装飾です。リンクは自動的に適切な色になります。

Abstract

abstractで使用できる装飾です。リンクは自動的に適切な色になります。

Info

infoで使用できる装飾です。リンクは自動的に適切な色になります。

Tip

tipで使用できる装飾です。リンクは自動的に適切な色になります。

Success

successで使用できる装飾です。リンクは自動的に適切な色になります。

Question

questionで使用できる装飾です。リンクは自動的に適切な色になります。

Warning

warningで使用できる装飾です。リンクは自動的に適切な色になります。

Failure

failureで使用できる装飾です。リンクは自動的に適切な色になります。

Danger

dangerで使用できる装飾です。リンクは自動的に適切な色になります。

Bug

bugで使用できる装飾です。リンクは自動的に適切な色になります。

Example

exampleで使用できる装飾です。リンクは自動的に適切な色になります。

Quote

quoteで使用できる装飾です。リンクは自動的に適切な色になります。

記事一覧

= "<ディレクトリ名>" =で囲むと、そのディレクトリの記事一覧を出力します。これはHTMLコード中でも使用できます。

例
= "blog" =

メモ

この機能がLantanaに実装されたことで従来WSOFTDocsに独自に実装されていた、{{ print_thumbnails('') }}関数は使用されなくなりました。これにより、ビルド時間が150%高速化しました。

スニペットの埋め込み

--8<--で囲い、その中にファイル名を書き込むと、そのファイルを埋め込みます。

Markdown
--8<--
snippet.md
--8<--

HTMLの埋め込み

HTMLコードは、そのまま記述することで埋め込むことができます。

Markdown
<h4>これはHTMLのH4タグです</h4>
結果

これはHTMLのH4タグです

属性の追加

{: 属性名}とするとマークダウンで生成される要素に特定の属性を追加することができます。

Markdown
### この要素にはqueryというIdがつきます {: #query }
結果

以下のようなHTMLが生成されます

<h3 id="query">この要素にはqueryというIdがつきます</h3>

検索
No results found