Skip to content

Commit 495ea82

Browse files
committed
Restore original syntax guide and quick reference
- Restore full syntax/index.md landing page - Restore original syntax/quick-ref.md with all content - Fix cumulative-docs links to point to docs-content - Add TODO comment about keeping quick-refs in sync
1 parent 82e8095 commit 495ea82

File tree

2 files changed

+700
-5
lines changed

2 files changed

+700
-5
lines changed

docs/syntax/index.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Syntax guide
22

3-
:::{note}
4-
👋 The syntax guide has moved to [elastic.co/docs](https://www.elastic.co/docs/contribute-docs/syntax).
5-
:::
3+
Learn about the custom Markdown syntax used in Elastic documentation.
4+
5+
## Quick reference
6+
7+
Refer to the [quick reference](quick-ref.md) for a condensed syntax cheat sheet.
8+
9+
## How it works
10+
11+
Elastic Docs V3 uses a custom implementation of [MyST](https://mystmd.org/) (Markedly Structured Text), which extends standard Markdown with directive syntax.
12+
13+
If you know [Markdown](https://commonmark.org), you already know most of what you need. If not, the CommonMark project offers a [10-minute tutorial](https://commonmark.org/help/).
14+
15+
When you need more than basic Markdown, you can use [directives](directives.md) to add features like callouts, tabs, and diagrams.
16+
17+
## GitHub Flavored Markdown support
18+
19+
V3 supports some GitHub Flavored Markdown extensions:
20+
21+
**Supported:**
22+
- Tables (basic pipe syntax)
23+
- Strikethrough with `~~text~~` (renders as ~~text~~)
24+
25+
**Not supported:**
26+
- Task lists
27+
- Automatic URL linking: https://www.elastic.co
28+
- Links must use standard Markdown syntax: [Elastic](https://www.elastic.co)
29+
- Using a subset of HTML

0 commit comments

Comments
 (0)