Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paper: Codebraid: Live Code in Pandoc Markdown #469

Merged
merged 25 commits into from Jul 3, 2019
Merged
Changes from 13 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c9232ff
initial commit; first draft
gpoore May 22, 2019
bc061d6
added section on working with external files
gpoore Jun 1, 2019
4b67613
rewrapped long line of code
gpoore Jun 1, 2019
bc12561
added JavaScript to list of supported languages
gpoore Jun 1, 2019
b0f310d
added docutils reference
gpoore Jun 1, 2019
d42e5f6
minor proofreading
gpoore Jun 1, 2019
f40096f
proofread bib file, fixed some en dashes and capitalization, made thi…
gpoore Jun 1, 2019
e4b4700
updated code block syntax for latest codebraid version
gpoore Jun 6, 2019
4153c3d
revised introduction and added review; proofreading
gpoore Jun 10, 2019
c40c9bf
added section on new support for jupyter kernels, moved and reorganiz…
gpoore Jun 10, 2019
1adf17c
added image for jupyter kernel example
gpoore Jun 10, 2019
416df57
edited conclusion
gpoore Jun 10, 2019
597cab1
proofreading
gpoore Jun 10, 2019
4bed505
converted review into shorter comparison plus appendix (includes Jupy…
gpoore Jun 17, 2019
fa751fb
removed discussion of Pandoc AST from example section (duplicates kni…
gpoore Jun 17, 2019
30e9568
modified section references due to new Pandoc attribute section
gpoore Jun 17, 2019
c4b80ea
edited command and display option descriptions: added reference to ne…
gpoore Jun 17, 2019
da84e43
edited code execution section: made language consistent with new intr…
gpoore Jun 17, 2019
04068ac
improved Jupyter kernel section: clarified multiple kernels in respon…
gpoore Jun 17, 2019
613cdea
advanced code execution section: proofreading
gpoore Jun 17, 2019
391d65c
edited external file section: clarification in response to @mwcraig
gpoore Jun 17, 2019
d5801c9
addressed most remaining points from @mwcraig: clarified raw display,…
gpoore Jun 17, 2019
38388d5
moved comparison to end per suggestion by @stefanv; added transition …
gpoore Jun 19, 2019
61ca592
proofreading
gpoore Jun 19, 2019
0723d76
addressed @mwcraig comments; removed reference to cb.nb example under…
gpoore Jun 22, 2019
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -0,0 +1,2 @@
codebraid pandoc -f markdown -t rst --overwrite -o geoffrey_poore.rst poore.txt
python patch_rst_conversion.py
@@ -0,0 +1,2 @@
codebraid pandoc -f markdown -t rst --overwrite -o geoffrey_poore.rst poore.txt

This comment has been minimized.

Copy link
@stefanv

stefanv Jun 12, 2019

Member

Nice :D 👍 🚀

This comment has been minimized.

Copy link
@deniederhut

deniederhut Jun 13, 2019

Member

Using the tool to talk about the tool 👏👏👏

python3 patch_rst_conversion.py

Large diffs are not rendered by default.

@@ -0,0 +1,18 @@
'''
Patch the geoffrey_poore.rst that is generated from poore.md with pandoc
```
codebraid pandoc -f markdown -t rst --overwrite -o geoffrey_poore.rst poore.txt
```
'''

import pathlib
import re

p = pathlib.Path('geoffrey_poore.rst')
text = p.read_text(encoding='utf8')
# Replace languages not supported by default docutils
text = re.sub('code:: (?:stdout|stderr|markdown|sourceError)', 'code:: text', text)
# Remove unsupported line numbering inserted by Pandoc
text = re.sub(' :number-lines:.*\n', '', text)
p.write_text(text, encoding='utf8')
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.