OurBigBook logoOurBigBook Docs OurBigBook logoOurBigBook.comSite Source code

-/raw directory

OurBigBook places output files that are not the output of .bigb to .html conversion (i.e. .html output files) under the -/raw/ prefix of the output.
Internal path links then automatically add the -/raw/ prefix to every link.
For example, consider an input directory that contains:
notindex.bigb
= Hello

Check out \a[myfile.c].

The source code for this file is at: \a[notindex.bigb].

\Image[myimg.png]
myfile.c
int i = 1;
myimg.png
Binary!
After conversion with:
ourbigbook .
the following files would exist in the output directory:
  • notindex.html: converted output of notindex.bigb
  • -/raw/notindex.bigb: a copy of the input source code notindex.bigb
  • -/raw/myfile.c: a copy of the input file myfile.c
  • -/raw/myimg.png: a copy of the input file myimg.c
and all links/image references would work and automtically point to the correct locations under -/raw.
Some live examples:
  • link to a file:
    The file \a[index.js] is cool.
    which renders as:
    The file index.js is cool.
  • link to a directory:
    The directory \a[file_demo] is cooler.
    which renders as:
    The directory file_demo is cooler.
The reason why a -/raw prefix is needed it to avoid naming conflicts with OurBigBook outputs, e.g. suppose we had the files:
  • configure
  • configure.bigb
Then, in a server that omits the .html extension, if we didn't have -/raw/ both configure.html and configure would be present under /configure. With -/raw we instead get:
  • -/raw/configure: the input /configure file
  • configure: the HTML

Tagged (1)

Ancestors (6)

  1. \a external argument
  2. \a argument
  3. Link
  4. Macro
  5. OurBigBook Markup
  6. Home

Incoming links (7)