Skip to content

Commit fb7335d

Browse files
committed
fix: typos, etc.
1 parent 7eebf69 commit fb7335d

File tree

4 files changed

+17
-25
lines changed

4 files changed

+17
-25
lines changed

content/embeds.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Embeds
22

3-
MyST This supports embedding of notebook content and other files. The following are some examples using the embed directive.
3+
MyST supports embedding of notebook content and other files. The following are some examples using the @xref:guide#directive-embed.
44

55
## A Matplotlib Output
66

@@ -25,7 +25,6 @@ MyST This supports embedding of notebook content and other files. The following
2525

2626
![](#eqn-mlp)
2727

28-
2928
## Embed a manual equation
3029

3130
![](#eqn-manual)
@@ -44,4 +43,4 @@ MyST This supports embedding of notebook content and other files. The following
4443

4544
## Embed a cell with multiple outputs
4645

47-
![](#out-multiple)
46+
![](#out-multiple)

content/external.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
MyST Supports cross-referencing into external content in order to create figures and embeds. External content could be in a different version of the AST and would need special handling.
44

5-
65
## An External Figure!
76

87
![](xref:guide#img:altair-horsepower)
@@ -17,23 +16,17 @@ MyST Supports cross-referencing into external content in order to create figures
1716
::::{tip} On local testing
1817
:class: dropdown
1918

20-
21-
1. get test source content in `folderA`
22-
* myst start --execute --headless
23-
* content server running on `localhost:3100`
24-
2. start myst-theme e.g. `npm run theme:book`
25-
* theme running on `localhost:3000`
26-
3. get second set of test content in `folderB`
27-
* add `local: http://localhost:3000` to `myst.yml#project.references`
28-
* add external cross references and embeds in `folderB` pointing to the local content in `folderA`
29-
* `myst start --execute --headless`
30-
* content server running on `localhost:3101`
31-
4. in a second `myst-theme` folder, or without fully restarting the theme from step 2
32-
* add a `.env` file to `themes/book`
33-
* add `CONTENT_CDN_PORT=3101`
34-
* `npm run theme:book`
35-
* theme running on `localhost:3001`
36-
* test this website 👆
19+
1. Get test source content in `folderA`
20+
`myst start --execute --headless` starts a content server running on `localhost:3100`.
21+
2. Start `myst-theme`
22+
`npm run theme:book` in the MyST Theme repository, e.g. `npm run theme:book` starts a theme running on `localhost:3000`.
23+
3. Get second set of test content in `folderB`
24+
1. Add `local: http://localhost:3000` to `myst.yml#project.references`.
25+
2. Add external cross references and embeds in `folderB` pointing to the local content in `folderA`.
26+
3. Start a second content server with `myst start --execute --headless`, which runs on `localhost:3101`.
27+
4. In a second `myst-theme` folder, or without fully restarting the theme from step 2.
28+
- Set `CONTENT_CDN_PORT=3101` in your environment, and run another MyST Theme process (see (2))
29+
5. Test this website 👆.
3730

3831
::::
3932

@@ -48,5 +41,5 @@ MyST Supports cross-referencing into external content in order to create figures
4841

4942
## cross references
5043

51-
* [To a notebook cell](xref:local#out:simple-matplotlib)
52-
* [To a figure](xref:local#fig:simple-matplotlib)
44+
- [To a notebook cell](xref:local#out:simple-matplotlib)
45+
- [To a figure](xref:local#fig:simple-matplotlib)

content/figures-w-placeholders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ An ipywidgets figure with a placeholder
5252
:::{figure} #out-multiple
5353
:label: fig-multiple-pl
5454
:placeholder: ./placeholder.jpg
55-
A notebook cell with mulitple outputs of differing mimetypes and a placeholder
55+
A notebook cell with multiple outputs of differing mimetypes and a placeholder
5656
:::

content/figures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,5 @@ An ipywidgets figure
4444

4545
:::{figure} #out-multiple
4646
:label: fig-multiple
47-
A notebook cell with mulitple outputs of differeing mimetypes
47+
A notebook cell with multiple outputs of differeing mimetypes
4848
:::

0 commit comments

Comments
 (0)