When you run:
it converts all files in the current directory separately, e.g.:
npx ourbigbook .
README.bigb
toindex.html
, sinceREADME
is a magic name that we want to show on the root URLnot-readme.bigb
tonot-readme.html
, as this one is a regular name unlikeREADME
main.scss
tomain.css
If one of the input files starts getting too large, usually the toplevel
Note however that when those individual files have a cross file reference to something defined in
to parse all files and extract all necessary IDs to the ID database. That would be optimized slightly wit the
to only extract the IDs but not render, which speeds things up considerably
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
not-readme.bigb
, e.g. via \x[h2-in-not-the-readme]
, then you must first do a first pass once with:
npx ourbigbook .
--no-render
command line option:
npx ourbigbook --no-render .
When dealing with large files, you might also be interested in the following amazing options:
To produce a single standalone output file that contains everything in a directory run:
You can now just give
npx ourbigbook --embed-resources --embed-includes README.bigb
xdg-open index.html
index.html
to any reader and they should be able to view it offline without installing anything. The flags are:--embed-includes
: without this,\Include[not-readme]
shows as a link to the filenot-readme.html
which comes fromnot-readme.bigb
With the flag,not-readme.bigb
output gets embedded into the outputindex.html
directly--embed-resources
: by default, we link to CSS and JavaScript that lives insidenode_modules
. With this flag, that CSS and JavaScript is copied inline into the document instead. One day we will try to handle images that way as well