If {check=0} is given, this disables the local file existence check that is done by default for relative links.
If check is not given explicitly, OurBigBook does the check by default if the link is not a URL with protocol. For example, the following are not checked:
  • http://cirosantilli.com
  • https://cirosantilli.com
  • file:///etc/fstab
  • ftp://cirosantilli.com
and the following are:
  • index.js
  • ../index.js
  • path/to/index.js
  • /path/to/index.js. Since it stats with a /, this path has to exist relative to project toplevel directory, not relative to the current .bigb source.
  • //example.com/path/to/index.js. This gets treated the same as /example.com/path/to/index.js.
For example, it is often the case in computer programming tutorials that we want to refer to source files in the current directory, so you could have in your README.bigb:
See this awesome source file: \a[index.js]
and then if index.js does not exist in the project, compilation leads to an error.
This check is important because as you start documenting several source files, it is almost inevitable getting wrong paths due to renames or typos without this type of error checking
The most common use case for disabling checks is as follows.
Therefore, if we did from README.bigb:
See this awesome style guide: \a[markdown-style-guide]
we do not want OurBigBook do check that the file markdown-style-guide exists in the local filesystem.
For this reason, we have instead to write:
See this awesome style guide: \a[markdown-style-guide]{check=0}
The general lesson is clear: in a server, paths could be re-routed to anything, including content that lies outside of a OurBigBook project.

Ancestors