Skip to content

Commit f6a0471

Browse files
authored
Update README.md
1 parent 0bbb263 commit f6a0471

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,36 +23,36 @@ A markdown kernel for Jupyter sounds like a stupid idea because Jupyter has
2323
native Markdown cells. The problem is that Jupyter markdown cells are
2424
rendered at the frontend and do not interact with Jupyter kernels.
2525
It is therefore difficult to pass variables from kernels to markdown cells
26-
to create dynamic output.
26+
to create dynamic output, as what RStudio/RMarkdown has been doing for a while
27+
(See ipython/ipython#2592, jupyter/help#41,and jupyter/notebook#3463 for related discussions).
2728

2829
This markdown kernel is a simple Jupyter kernel that parses and displays
29-
the cell content as markdown. So that you can type in markdown texts
30+
cell content as markdown. Cells with markdown texts such as
3031

3132
```
3233
* This is *important*
3334
* This is not.
3435
```
3536

36-
and it would be rendered as
37+
would produce output
3738

3839
* This is *important*
3940
* This is not.
4041

41-
4242
But wait, this is *still stupid* because you can do the same thing in
4343
Jupyter, only easier. What is the point of a markdown kernel by itself?
4444

45-
The answer is that you can use this markdown kernel with [SoS
45+
The answer is that you can use this a markdown kernel with [SoS
4646
Notebook](http://vatlab.github.com/sos-docs). In SoS Notebook, you can
47-
create variables in SoS (Python) and pass them to cells of Markdown kernel
47+
create variables in SoS (Python) and pass them to cells of a Markdown kernel
4848
as
4949

5050
```
5151
%expand
5252
The result of the analysis is {result}
5353
```
5454

55-
or if you have `{ }` in your text, you can specify an alternative sigil
55+
or if you have multiple `{ }` in your text, you can specify an alternative sigil
5656

5757
```
5858
%expand ${ }
@@ -61,4 +61,4 @@ The result of the analysis is ${result}
6161
as shown in
6262
![example](https://user-images.githubusercontent.com/9889312/37932344-e1c13e96-310d-11e8-963c-5fe26c6523d1.png)
6363

64-
Note that SoS recognizes the `%expand` magic and highlights the intepolated texts.
64+
Note that SoS recognizes the [`%expand` magic](https://vatlab.github.io/sos-docs/doc/documentation/SoS_Magics.html#magic_expand) and highlights the intepolated expressions. SoS essentially treats the cell content as [Python f-strings](https://www.python.org/dev/peps/pep-0498/) (with configurable sigil) so almost arbitrary Python expressions could be used. In addition, instead of passing variables from subkernels to SoS and to a markdown cell, you can use a [`%render` magic](https://vatlab.github.io/sos-docs/doc/documentation/SoS_Magics.html#magic_render) to render output from any subkernels as markdown.

0 commit comments

Comments
 (0)