NixOS/nix-pills
NixOS/nix-pills
1
0
Fork 0
mirror of https://github.com/NixOS/nix-pills synced 2024-09-18 03:50:12 -04:00
Code Activity
345 commits 2 branches 0 tags 1.8 MiB
JavaScript 87.3%
Nix 10.6%
CSS 2.1%
Find a file
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
.github/workflows Add simple CI workflow 2021-11-26 22:02:58 +01:00
pills Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
theme Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
.editorconfig initialize an editorconfig 2017-08-13 09:54:34 -04:00
.gitignore Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
book.toml Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
custom.css Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
default.nix Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
LICENSE License it CC-BY-SA-4.0 per #36 where every existing contributor agreed 2017-12-19 07:04:41 -05:00
README.md Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00
release.nix Convert from docbook to mdbook (#233) 2024-04-08 16:37:11 -07:00

README.md

Nix Pills

Available online as a multi-page HTML or an e-book in EPUB format.

You can also build them locally:

nix-build release.nix -A html-split && firefox result/share/doc/nix-pills/index.html

Similarly, for an EPUB version, run:

nix-build release.nix -A epub && foliate result/share/doc/nix-pills/nix-pills.epub