-
-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 66936f1)
* Re-add heading id
It was removed in pandoc step for some reason.
(cherry picked from commit cf39aa5)
* 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 bc9bd13)
* 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 <[email protected]>
Co-authored-by: Jan Tojnar <[email protected]>- Loading branch information
3 people
authored
Apr 8, 2024
1 parent
2355217
commit 4033045
Showing
246 changed files
with
4,453 additions
and
7,226 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| result | ||
| result-* | ||
| /book* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| [book] | ||
| title = "Nix Pills" | ||
| authors = ["Luca Bruno"] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "pills" | ||
|
|
||
| [output.html] | ||
| additional-css = ["custom.css"] | ||
| edit-url-template = "https://github.com/NixOS/nix-pills/tree/master/{path}" | ||
| git-repository-url = "https://github.com/NixOS/nix-pills" | ||
|
|
||
| [output.html.redirect] | ||
| "pr01.html" = "00-preface.html" | ||
| "why-you-should-give-it-a-try.html" = "01-why-you-should-give-it-a-try.html" | ||
| "install-on-your-running-system.html" = "02-install-on-your-running-system.html" | ||
| "enter-environment.html" = "03-enter-environment.html" | ||
| "basics-of-language.html" = "04-basics-of-language.html" | ||
| "functions-and-imports.html" = "05-functions-and-imports.html" | ||
| "our-first-derivation.html" = "06-our-first-derivation.html" | ||
| "working-derivation.html" = "07-working-derivation.html" | ||
| "generic-builders.html" = "08-generic-builders.html" | ||
| "automatic-runtime-dependencies.html" = "09-automatic-runtime-dependencies.html" | ||
| "developing-with-nix-shell.html" = "10-developing-with-nix-shell.html" | ||
| "garbage-collector.html" = "11-garbage-collector.html" | ||
| "inputs-design-pattern.html" = "12-inputs-design-pattern.html" | ||
| "callpackage-design-pattern.html" = "13-callpackage-design-pattern.html" | ||
| "override-design-pattern.html" = "14-override-design-pattern.html" | ||
| "nix-search-paths.html" = "15-nix-search-paths.html" | ||
| "nixpkgs-parameters.html" = "16-nixpkgs-parameters.html" | ||
| "nixpkgs-overriding-packages.html" = "17-nixpkgs-overriding-packages.html" | ||
| "nix-store-paths.html" = "18-nix-store-paths.html" | ||
| "fundamentals-of-stdenv.html" = "19-fundamentals-of-stdenv.html" | ||
| "basic-dependencies-and-hooks.html" = "20-basic-dependencies-and-hooks.html" | ||
|
|
||
| [output.linkcheck] | ||
| follow-web-links = true | ||
|
|
||
| # To build the epub version, run: | ||
| # mdbook-epub --standalone true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| .info { | ||
| margin: 20px; | ||
| padding: 0 20px; | ||
| border-inline-start: 2px solid var(--links); | ||
| } | ||
|
|
||
| .info:before { | ||
| position: absolute; | ||
| width: 3rem; | ||
| height: 3rem; | ||
| margin-inline-start: calc(-1.5rem - 21px); | ||
| content: "ⓘ"; | ||
| text-align: center; | ||
| background-color: var(--bg); | ||
| color: var(--links); | ||
| font-weight: bold; | ||
| font-size: 2rem; | ||
| } | ||
|
|
||
| /* | ||
| Make prompts unselectable in console sections. | ||
| This relies on highlight.js applying certain classes on the prompts. | ||
| For more details, see https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html#stylable-scopes | ||
| */ | ||
| .hljs-meta.prompt_ { | ||
| user-select: none; | ||
| -webkit-user-select: none; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Preface | ||
|
|
||
| This is a ported version of the **Nix Pills**, a series of blog posts written by **Luca Bruno** (aka Lethalman) and originally published in 2014 and 2015. It provides a tutorial introduction into the Nix package manager and Nixpkgs package collection, in the form of short chapters called 'pills'. | ||
|
|
||
| Since the Nix Pills are considered a classic introduction to Nix, an effort to port them to the current format was led by Graham Christensen (aka grahamc / gchristensen) and other contributors in 2017. | ||
|
|
||
| For an up-to-date version, please visit <https://nixos.org/guides/nix-pills/>. An [EPUB version](https://nixos.org/guides/nix-pills/nix-pills.epub) is also available. | ||
|
|
||
| If you encounter problems, please report them on the [nixos/nix-pills](https://github.com/NixOS/nix-pills/issues) issue tracker. | ||
|
|
||
| <div class="info"> | ||
|
|
||
| Note: Commands prefixed with `#` have to be run as root, either requiring to login as root user or temporarily switching to it using `sudo` for example. | ||
|
|
||
| </div> |
Oops, something went wrong.