Skip to content

Commit 88f9117

Browse files
committed
Update feature list and usage example
(And bug fixes, of course.)
1 parent 07f7aa8 commit 88f9117

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Usage:`jb2htmlbook [OPTIONS] SOURCE TARGET`
2727
Help text:
2828

2929
```
30+
$ jb2htmlbook --help
3031
Usage: jb2htmlbook [OPTIONS] SOURCE TARGET
3132
3233
Converts a Jupyter Book project into HTMLBook.
@@ -53,20 +54,21 @@ Options:
5354
--atlas-json TEXT Path to the book's atlas.json file
5455
--skip-jb-build Skip running `jupyter-book` as a part of
5556
this conversion
56-
--skip-numbering Skip the numbering of In[]/Out[] code cells
57+
--skip-numbering Skip the numbering of In[]/Out[] code cells
5758
--include-root Include the 'root' file of the jupyter-book
5859
project
60+
--keep-highlighting Preserve any code highlighting provided by
61+
Jupyter Book
5962
--version
6063
--install-completion [bash|zsh|fish|powershell|pwsh]
6164
Install completion for the specified shell.
6265
--show-completion [bash|zsh|fish|powershell|pwsh]
6366
Show completion for the specified shell, to
6467
copy it or customize the installation.
6568
--help Show this message and exit.
66-
6769
```
6870

69-
## Current Known Limitations
71+
## Current (Known) Limitations
7072

7173
* Jupyter Book can only process one metadata-named code-generated figure per file. The workaround for this is to save any resultant figures to disk and refer to them as any other figure.
7274

@@ -76,11 +78,23 @@ Options:
7678

7779
Features:
7880
- Upgrade to Jupyter Book v.0.15.1
81+
- `--keep-highlighting` flag to preserve syntax highlighting for code blocks provided by Jupyter Book
82+
83+
Bug fixes:
84+
- Table caption numbering is now removed from output (was causing duplicates in Atlas builds)
85+
- Additional safeguards around figure markup
86+
- Generated part.html files now have correctly-numbered (and unique) IDs
87+
88+
Quality of life improvements:
89+
- Explicit tests for common PE tasks
90+
- Additional examples in the `example_book`
91+
- Improved type hints
92+
7993

8094
### 1.0.9
8195

8296
Bug fixes:
83-
- Remove spans inside `<code>` tags that display incorrectly on the ORM learning platform.
97+
- Remove spans inside `<code>` tags that display incorrectly on the ORM learning platform
8498

8599
### 1.0.8
86100

0 commit comments

Comments
 (0)