OurBigBook Docs OurBigBook.comSite
When you run:
npx ourbigbook .
it converts all files in the current directory separately, e.g.:
  • README.bigb to out/html/index.html, since README is a magic name that we want to show on the root URL
  • not-readme.bigb to out/html/not-readme.html, as this one is a regular name unlike README
  • main.scss to main.css
If one of the input files starts getting too large, usually the toplevel README.bigb in which you dump everything by default like Ciro does, you can speed up development and just compile files individually with either:
npx ourbigbook README.bigb
npx ourbigbook not-readme.bigb
Note however that when those individual files have a cross file reference to something defined in not-readme.bigb, e.g. via \x[h2-in-not-the-readme], then you must have first previously done pass once with:
npx ourbigbook .
to parse all files and extract all necessary IDs to the ID database. That would be optimized slightly with the --no-render command line option:
npx ourbigbook --no-render .
to only extract the IDs but not render, which speeds things up considerably
When dealing with large files, you might also be interested in the following amazing options:


  1. OurBigBook CLI quick start
  2. OurBigBook CLI
  3. OurBigBook Project