nix-pills/README.md
Jan Tojnar 8291ca1677 Revert "Convert from docbook to mdbook (#233)"
This reverts commit 4033045782.

To preserve history.
2024-04-09 01:46:08 +02:00

1.6 KiB

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

Development

Emacs config for a nice DocBook experience:

let
 pkgs = import <nixpkgs> {};
 inherit (pkgs) emacsPackagesNg docbook5 writeText;

 schemas = writeText "schemas.xml" ''
   <locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
     <documentElement localName="section" typeId="DocBook"/>
     <documentElement localName="chapter" typeId="DocBook"/>
     <documentElement localName="article" typeId="DocBook"/>
     <documentElement localName="book" typeId="DocBook"/>
     <typeId id="DocBook" uri="${docbook5}/xml/rng/docbook/docbookxi.rnc" />
   </locatingRules>
 '';

in emacsPackagesNg.emacsWithPackages (epkgs: [
 (emacsPackagesNg.trivialBuild {
   pname = "nix-docbook-mode";
   version = "1970-01-01";
   src = writeText "default.el" ''
     (eval-after-load 'rng-loc
       '(add-to-list 'rng-schema-locating-files "${schemas}"))
     (global-set-key (kbd "<C-return>") 'nxml-complete)
   '';
 })
])

Then you can use the keys:

  • C-c C-b to finish & close a tag
  • C-c C-f to close a tag
  • C-return to auto-complete a tag or attribute.