|
2 | 2 | sd_hide_title: true |
3 | 3 | --- |
4 | 4 |
|
5 | | -# 🔎 Overview |
6 | | - |
7 | | -::::{grid} |
8 | | -:reverse: |
9 | | -:gutter: 3 4 4 4 |
10 | | -:margin: 1 2 1 2 |
11 | | - |
12 | | -:::{grid-item} |
13 | | -:columns: 12 4 4 4 |
14 | | - |
15 | | -```{image} _static/logo-square.svg |
16 | | -:width: 200px |
17 | | -:class: sd-m-auto |
18 | | -:name: landing-page-logo |
19 | | -``` |
20 | | - |
21 | | -::: |
22 | | - |
23 | | -:::{grid-item} |
24 | | -:columns: 12 8 8 8 |
25 | | -:child-align: justify |
26 | | -:class: sd-fs-5 |
27 | | - |
28 | | -```{rubric} MyST - Markedly Structured Text - Parser |
29 | | -``` |
30 | | - |
31 | | -A Sphinx and Docutils extension to parse MyST, |
32 | | -a rich and extensible flavour of Markdown for authoring technical and scientific documentation. |
33 | | - |
34 | | -````{div} sd-d-flex-row |
35 | | -```{button-ref} intro |
36 | | -:ref-type: doc |
37 | | -:color: primary |
38 | | -:class: sd-rounded-pill sd-mr-3 |
39 | | -
|
40 | | -Get Started |
41 | | -``` |
42 | | -
|
43 | | -```{button-ref} live-preview |
44 | | -:ref-type: doc |
45 | | -:color: secondary |
46 | | -:class: sd-rounded-pill |
47 | | -
|
48 | | -Live Demo |
49 | | -``` |
50 | | -```` |
51 | | - |
52 | | -::: |
53 | | - |
54 | | -:::: |
55 | | - |
56 | | ---- |
57 | | - |
58 | | -::::{grid} 1 2 2 3 |
59 | | -:gutter: 1 1 1 2 |
60 | | - |
61 | | -:::{grid-item-card} {octicon}`markdown;1.5em;sd-mr-1` CommonMark-plus |
62 | | -:link: syntax/core |
63 | | -:link-type: ref |
64 | | - |
65 | | -MyST extends the CommonMark syntax specification, to support technical authoring features such as tables and footnotes. |
66 | | - |
67 | | -+++ |
68 | | -[Learn more »](syntax/core) |
69 | | -::: |
70 | | - |
71 | | -:::{grid-item-card} {octicon}`plug;1.5em;sd-mr-1` Sphinx compatible |
72 | | -:link: roles-directives |
73 | | -:link-type: ref |
74 | | - |
75 | | -Use the MyST role and directive syntax to harness the full capability of Sphinx, such as admonitions and figures, and all existing Sphinx extensions. |
76 | | - |
77 | | -+++ |
78 | | -[Learn more »](roles-directives) |
79 | | -::: |
80 | | - |
81 | | -:::{grid-item-card} {octicon}`tools;1.5em;sd-mr-1` Highly configurable |
82 | | -:link: configuration |
83 | | -:link-type: doc |
84 | | - |
85 | | -MyST-parser can be configured at both the global and individual document level, |
86 | | -to modify parsing behaviour and access extended syntax features. |
87 | | - |
88 | | -+++ |
89 | | -[Learn more »](configuration) |
90 | | -::: |
91 | | - |
92 | | -:::: |
93 | | - |
94 | | ---- |
95 | | - |
96 | | -```{rubric} Additional resources |
97 | | -``` |
98 | | - |
99 | | -[MyST-Markdown VS Code extension](https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight) |
100 | | -: For MyST extended syntax highlighting and authoring tools. |
101 | | - |
102 | | -[Convert existing ReStructuredText files to Markdown][rst-to-myst] |
103 | | -: Use the [rst-to-myst] CLI or [the MySTyc interactive web interface](https://astrojuanlu.github.io/mystyc/). |
104 | | - |
105 | | -[markdown-it-py] |
106 | | -: A CommonMark-compliant and extensible Markdown parser, used by MyST-Parser to parse source text to tokens. |
107 | | - |
108 | | -```{rubric} Acknowledgements |
109 | | -``` |
110 | | - |
111 | | -The MyST markdown language and MyST parser are both supported by the open community, |
112 | | -[The Executable Book Project](https://executablebooks.org). |
113 | | - |
114 | | -```{toctree} |
115 | | -:hidden: |
116 | | -README.md |
117 | | -live-preview.md |
118 | | -``` |
119 | | - |
120 | 5 | ```{toctree} |
121 | 6 | :hidden: |
122 | 7 | :caption: Machine learning |
|
0 commit comments