1
0
Fork 0
mirror of https://github.com/NixOS/nix-pills synced 2024-09-19 04:00:13 -04:00
nix-pills/pills
Noam Yorav-Raphael 4033045782
Convert from docbook to mdbook (#233)
* Transform <xi:include> elements to include content

* Remove 3 files which were not referenced

The files were probably included in previous versions and weren't
removed.

* Automatic conversion using pandoc

I just run `pandoc {fn} -f docbook -t markdown --wrap=none -s -o {fn.with_suffix(".md")}` over all .xml files in pills/, and on /book.xml

I manually created SUMMARY.md based on the list in book.xml.

* Remove front matter from 00-preface.md

* Support "note" sections, fix inter-links

* Fix code sections with highlighting, which pandoc missed

* Replace `\'` with `'`.

* Replace `\"` with `"`.

* Replace `\...` with `...`

* Format markdown with Prettier

* Convert code section to fenced, with the appropriate syntax

* Build the book with Nix

* Add highlight.js which supports nix syntax highlighting

* Add redirects from original paths to new paths

* make prompts unselectable

* README: Remove DocBook-specific instructions

(cherry picked from commit 66936f15a5)

* Re-add heading id

It was removed in pandoc step for some reason.

(cherry picked from commit cf39aa5ad9)

* Fix footnote rendering with mdbook-epub

mdbook-epub 0.4.37 will collapse the second footnote into the first one.
This does not happen with HTML output from plain mdbook.

(cherry picked from commit bc9bd13844)

* Manually added backticks for <package> tags in original

* Put «» around what was originally <replaceable>

* epub: Remove extra page breaks before headings

The sections are pretty short, leading to unnecessary pagination being required.

---------

Co-authored-by: Noam Yorav-Raphael <noam.yoravraphael@mobileye.com>
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2024-04-08 16:37:11 -07:00
..
00-preface.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
01-why-you-should-give-it-a-try.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
02-install-on-your-running-system.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
03-enter-environment.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
04-basics-of-language.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
05-functions-and-imports.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
06-our-first-derivation.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
07-working-derivation.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
08-generic-builders.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
09-automatic-runtime-dependencies.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
10-developing-with-nix-shell.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
11-garbage-collector.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
12-inputs-design-pattern.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
13-callpackage-design-pattern.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
14-override-design-pattern.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
15-nix-search-paths.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
16-nixpkgs-parameters.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
17-nixpkgs-overriding-packages.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
18-nix-store-paths.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
19-fundamentals-of-stdenv.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
20-basic-dependencies-and-hooks.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
SUMMARY.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00