本文へスキップ

Markdown Style Guide

Markdown Style Guide のヒーロー画像
Part 2 / 2
  1. 1 Astroブログを組み立てる
  2. 2 Markdown Style Guide

Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro.

Astro Documentation Astro の基本からコンテンツコレクション、MDX、デプロイまで確認できる公式ドキュメントです。 docs.astro.build Docs Markdown Content Astro Docs Astro の Markdown / MDX 記事で使える構文と設定のリファレンスです。 docs.astro.build
BibTeX @article 2017
Attention Is All You Need

Ashish Vaswani, Noam Shazeer, Niki Parmar, Jakob Uszkoreit, Llion Jones, Aidan N. Gomez, Lukasz Kaiser, Illia Polosukhin · Advances in Neural Information Processing Systems

BibTeX を貼るだけで、記事内に読みやすい参考文献カードとコピー可能な BibTeX ソースを表示できます。

arxiv.org
BibTeX source 
@article{vaswani2017attention,
title = {Attention Is All You Need},
author = {Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N. and Kaiser, Lukasz and Polosukhin, Illia},
journal = {Advances in Neural Information Processing Systems},
year = {2017},
url = {https://arxiv.org/abs/1706.03762}
}

Headings

The following HTML <h1>—<h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.

H1

H2

H3

H4

H5
H6

Paragraph

Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.

Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.

Callouts

Code Color Test

Inline code should stay readable in both themes, like const theme = "dark" or pnpm build.

type Theme = "light" | "dark";

const nextTheme: Theme = document.documentElement.classList.contains("dark")
  ? "light"
  : "dark";

Math

Inline math should render in the text flow, like E=mc2E = mc^2 and α+β=γ\alpha + \beta = \gamma.

Block math should render centered and scroll horizontally when needed:

∫−∞∞e−x2 ⁣dx=π\int_{-\infty}^{\infty} e^{-x^2} \dd x = \sqrt{\pi}

Machine learning macros are available for common notation:

θ⋆=arg min⁡θ∈RdE(x,y)∼D[L(fθ(x),y)]\theta^\star = \argmin_{\theta \in \R^d} \expect_{(x, y) \sim \data}\left[ \loss\left(f_\theta(x), y\right) \right] KL⁡(qϕ(z ∣ x) ∥ p(z))=E[log⁡qϕ(z ∣ x)−log⁡p(z)],h=softmax⁡(Wx+b)\KL\left(q_\phi(z \given x) \,\middle\Vert\, p(z)\right) = \expect\left[ \log q_\phi(z \given x) - \log p(z) \right], \quad \vect{h} = \softmax(\mat{W}x + b)

Images

Syntax

![Alt text](./full/or/relative/path/of/image)

Output

blog placeholder

Blockquotes

The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.

Blockquote without attribution

Syntax

> Tiam, ad mint andaepu dandae nostion secatur sequo quae.  
> **Note** that you can use _Markdown syntax_ within a blockquote.

Output

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.

Blockquote with attribution

Syntax

> Don't communicate by sharing memory, share memory by communicating.<br />
> — <cite>Rob Pike[^1]</cite>

Output

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike1

Tables

Syntax

| Italics   | Bold     | Code   |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |

Output

ItalicsBoldCode
italicsboldcode

Code Blocks

Syntax

we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntax, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash

```html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>
```

Output

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Example HTML5 Document</title>
  </head>
  <body>
    <p>Test</p>
  </body>
</html>

List Types

Ordered List

Syntax

1. First item
2. Second item
3. Third item

Output

  1. First item
  2. Second item
  3. Third item

Unordered List

Syntax

- List item
- Another item
- And another item

Output

  • List item
  • Another item
  • And another item

Nested list

Syntax

- Fruit
  - Apple
  - Orange
  - Banana
- Dairy
  - Milk
  - Cheese

Output

  • Fruit
    • Apple
    • Orange
    • Banana
  • Dairy
    • Milk
    • Cheese

Other Elements — abbr, sub, sup, kbd, mark

Syntax

<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.

H<sub>2</sub>O

X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>

Press <kbd>CTRL</kbd> + <kbd>ALT</kbd> + <kbd>Delete</kbd> to end the session.

Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.

Output

GIF is a bitmap image format.

H2O

Xn + Yn = Zn

Press CTRL + ALT + Delete to end the session.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

Footnotes

  1. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩

次に読む

この記事の前提や続きを確認したい場合は、関連する記事と用語集をあわせて読むと全体像を追いやすくなります。

Astroブログを組み立てる Astro、TypeScript、Tailwind CSSでブログの土台を作るテスト記事です。 Cloudflare Pages に公開する Astroブログを Cloudflare Pages へデプロイする流れを確認するテスト記事です。 統計・情報幾何の用語集 Fisher 計量、接空間、p 値、検出力などの短い説明をまとめています。