[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/code-cells aefabc4abf 10/36: Comments about ipynb conve
From: |
ELPA Syncer |
Subject: |
[elpa] externals/code-cells aefabc4abf 10/36: Comments about ipynb conversion settings |
Date: |
Mon, 28 Feb 2022 15:57:41 -0500 (EST) |
branch: externals/code-cells
commit aefabc4abf18bdd02fa1b0d246e9c47cdec387e6
Author: Augusto Stoffel <astoff@users.noreply.github.com>
Commit: Augusto Stoffel <astoff@users.noreply.github.com>
Comments about ipynb conversion settings
---
README.md | 30 +++++++++++++++++++++---------
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index ab431114d3..e0de5e3668 100644
--- a/README.md
+++ b/README.md
@@ -177,28 +177,40 @@ key in an interactive lambda when it is a sexp, we need
to use
### Tweaking the ipynb conversion
-The default settings translate notebooks to Jupytext's “percent”
-format, but this can be changed. To convert to markdown, use to
-following:
+If relegating markdown cells to comment blocks offends your literate
+programmer sensibilities, try including the following in the YAML
+header of a converted notebook (and then save and revert it). It will
+cause text cells to be displayed as multiline comments.
+
+``` yaml
+jupyter:
+ jupytext:
+ cell_markers: '"""'
+```
+
+It is also possible to convert notebooks to markdown or org format.
+For markdown, use the following:
``` elisp
-(setq cells-ipynb-convert-style '(("jupytext" "--to" "ipynb" "--from"
"markdown")
+(setq cells-convert-ipynb-style '(("jupytext" "--to" "ipynb" "--from"
"markdown")
("jupytext" "--to" "markdown" "--from"
"ipynb")
markdown-mode))
```
-To edit ipynb files as org documents, try using [Pandoc] like this:
+To edit ipynb files as org documents, try using [Pandoc] with the
+configuration below. In combination with org-babel, this can provide
+a true Emacsesque notebook experience.
```elisp
-(setq cells-ipynb-convert-style '(("pandoc" "--to" "ipynb" "--from" "org")
+(setq cells-convert-ipynb-style '(("pandoc" "--to" "ipynb" "--from" "org")
("pandoc" "--to" "org" "--from" "ipynb")
org-mode))
```
A good reason to stick with Jupytext, though, is that it offers
-round-trip stability: if you save a script and then revert the buffer,
-the buffer shouldn't change. With other tools, you may get some
-surprises.
+round-trip consistency: if you save a script and then revert the
+buffer, the buffer shouldn't change. With other tools, you may get
+some surprises.
Alternatives
------------
- [elpa] externals/code-cells 374edc6be7 20/36: Change package description, (continued)
- [elpa] externals/code-cells 374edc6be7 20/36: Change package description, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 1bd650391a 25/36: Update README, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 4e973e0122 26/36: Do not assume Emacs has native JSON parsing available, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 185c33b8b6 27/36: Fix cell movement for files without newline at the end, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 031f726941 30/36: code-cells-eval: Fix check for a possibly active minor mode, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells ea7799c447 35/36: Release on ELPA, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 37dce1d908 02/36: Add existing code, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 30c0359c36 03/36: Simplify motion code, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells aeddd889c2 04/36: Add ipynb support via Jupytext, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells e02bda5b68 09/36: Assorted refinements, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells aefabc4abf 10/36: Comments about ipynb conversion settings,
ELPA Syncer <=
- [elpa] externals/code-cells 7bad8f1cf6 11/36: Speed keys, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 2dc51b44a3 12/36: Correct outline level before first cell header, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 9500e07f83 15/36: Fix byte-compilation issue, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells adda62ec82 16/36: Address some packaging issues, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 67e1479a75 28/36: Add code-cells-mode-maybe, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells f93db2d65c 29/36: Refinement in Commentary section, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 47305f5439 31/36: Indicate that spaces are allowed before cell boundary marker, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 68148cfc1f 33/36: Improve cell boundary face, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells f5150fc213 34/36: Update README.md, ELPA Syncer, 2022/02/28
- [elpa] externals/code-cells 55e108733a 06/36: Add helper function to call external processes, ELPA Syncer, 2022/02/28