Skip to content

Commit 4116985

Browse files
authored
📖 Updates to new mystmd features (#65)
1 parent b63a28c commit 4116985

File tree

5 files changed

+34
-12
lines changed

5 files changed

+34
-12
lines changed

docs/features/commonmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ which is used to structurally seperate content.
7979
```
8080

8181
```{seealso}
82-
These can be used in [](inline-links) and are similar to [](./references.md) in MyST.
82+
These can be used in [](#inline-links) and are similar to [](./references.md) in MyST.
8383
This syntax is also similar to [](./footnotes.md).
8484
```
8585

docs/features/references.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Targets are custom anchors that you can refer to elsewhere, for example, a figur
1515
% TODO: name/label redundancy here would nice to be able to simplfy the onboarding (just use label, same as tex and mdast)
1616

1717
```{note}
18-
There is different syntax for creating [Section/Header targets](targeting-headers) and ways to [label equations](targeting-equations) when using dollar math.
18+
There is different syntax for creating [Section/Header targets](#targeting-headers) and ways to [label equations](#targeting-equations) when using dollar math.
1919
```
2020

21-
Cross-referencing content is accomplished with markdown link syntax (`[text](link)`) or through specific roles ([ref](ref-role), [numref](numref-role), [eq](eq-role) or [doc](doc-role)), depending on your use-case.
21+
Cross-referencing content is accomplished with markdown link syntax (`[text](#link)`) or through specific roles ([ref](#ref-role), [numref](#numref-role), [eq](#eq-role) or [doc](#doc-role)), depending on your use-case.
2222

2323
### Specification
2424

@@ -36,17 +36,17 @@ Cross-referencing content is accomplished with markdown link syntax (`[text](lin
3636

3737
### Using Markdown Links
3838

39-
Using markdown link syntax is one of the most versatile ways to link to content. This uses the standard CommonMark syntax for a link (`[text](link)`), and the link can either be a label or a link to a document. For example:
39+
Using markdown link syntax is one of the most versatile ways to link to content. This uses the standard CommonMark syntax for a link (`[text](#link)`), and the link can either be a label or a link to a document. For example:
4040

4141
````{list-table}
4242
* - MyST Syntax
4343
- Rendered
4444
* - ```
4545
[A **bolded _reference_** to a page](./references.md)
46-
[A reference to a header](targeting-headers)
46+
[A reference to a header](#targeting-headers)
4747
```
4848
- [A **bolded _reference_** to a page](./references.md)\
49-
[A reference to a header](targeting-headers)
49+
[A reference to a header](#targeting-headers)
5050
````
5151

5252
```{note}
@@ -85,7 +85,7 @@ The `{numref}` role is exactly the same as the above `{ref}` role, but also allo
8585

8686
### Using the `{eq}` role
8787

88-
The `` {eq}`my-equation` `` syntax creates a numbered link to the equation, which is equivalent to `[](my-equation)` as there is no text content to fill in a title or caption.
88+
The `` {eq}`my-equation` `` syntax creates a numbered link to the equation, which is equivalent to `[](#my-equation)` as there is no text content to fill in a title or caption.
8989

9090
% TODO: I think we should improve the syntax of links and simplify the explination
9191
% It is annoying that numref and ref don't work for equations.

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# MyST Specification
22

3-
```{warning}
4-
`myst-spec` is in development; any structures or features present in the JSON schema may change at any time without notice.
5-
```
6-
73
MyST (Markedly Structured Text) is designed to create publication-quality, computational documents written entirely in Markdown. The main use case driving the development and design of MyST is [JupyterBook](https://jupyterbook.org/), which creates educational online textbooks and tutorials with Jupyter Notebooks and narrative content written in MyST.
84

95
## Overview
@@ -12,7 +8,7 @@ There are three components that this documentation and repository aims to formal
128

139
1. the MyST markup language, which is a superset of [CommonMark](https://commonmark.org/) (a standard form of Markdown);
1410
2. the MyST abstract syntax tree (AST), which is the datastructure of a document after it has been parsed, and can be used in transforming and rendering content; and
15-
3. a set of unittests that can be used to test implementations of MyST (e.g. in Python and Javascript).
11+
3. a set of unit-tests that can be used to test implementations of MyST (e.g. in Python and Javascript).
1612

1713
## MyST Markup Language
1814

@@ -40,4 +36,8 @@ Test cases are available for download here: https://unpkg.com/browse/myst-spec/d
4036

4137
## Working with the MyST AST
4238

39+
```{warning}
40+
The `myst-spec` AST is in development; any structures or features present in the JSON schema may change at any time without notice.
41+
```
42+
4343
This documentation contains all the node types used to construct a MyST document. Conventionally, the AST representation of a MyST document represents the state immediately after parsing. This means, for example, references are not resolved, directive/role structures are still present, etc. You may work with AST nodes by either modifying or adding to them to modify and update the corresponding MyST document, or you may transform and reduce them into a simpler structure to consume in other contexts.

docs/myst.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: 1
2+
project:
3+
title: MyST Spec
4+
github: https://github.com/executablebooks/myst-spec
5+
license:
6+
code: MIT
7+
content: CC-BY-4.0
8+
subject: Specification
9+
venue:
10+
title: MyST Spec
11+
site:
12+
title: MyST Spec
13+
actions:
14+
- title: GitHub
15+
url: https://github.com/executablebooks/myst-spec
16+
domains:
17+
- mystmd-spec.curve.space
18+
options:
19+
twitter: mystmarkdown
20+
logo: public/logo.svg
21+
logo_text: MyST Spec

docs/public/logo.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)