`ourbigbook.json`

OurBigBook configuration file that affects the behaviour of ourbigbook for all files in the directory.

ourbigbook.json not used for input from stdin, since we are mostly doing quick tests in that case.

While ourbigbook.json is optional, it is used to determine the toplevel directory of a OurBigBook project, which has some effects such as those mentioned at the toplevel index file.

Therefore, it is recommended that you always have a ourbigbook.json in your project's toplevel directory, even if it is going to be an empty JSON containing just:

{}

For example, if you convert a file in a subdirectory such as:

ourbigbook subdir/notindex.bigb

then ourbigbook walks up the filesystem tree looking for ourbigbook.json, e.g.:

is there a ./subdir/ourbigbook.json?
otherwise, is there a ./ourbigbook.json?
otherwise, is there a ../ourbigbook.json?
otherwise, is there a ../../ourbigbook.json?

and so on.

If we reach the root path / and no ourbigbook.json is found, then we understand that there is no ourbigbook.json file present.

Table of contents 3k 33
- dontIgnore ourbigbook.json 72
- dontIgnoreConvert ourbigbook.json 8
- ignore ourbigbook.json 154
- ignoreRender ourbigbook.json 58
- ourbigbook.json id ourbigbook.json 280 4
  - id normalize latin ourbigbook.json id 209 1
    - Latin normalization id normalize latin 199
  - id normalize punctuation ourbigbook.json id 65 1
    - Punctuation normalization id normalize punctuation 55
- lint ourbigbook.json 134 2
  - lint h-parent lint 76
  - lint h-tag lint 28
- h ourbigbook.json 321 3
  - numbered h 106
  - splitDefault h 16
  - splitDefaultNotToplevel h 192
- htmlXExtension ourbigbook.json 14
- media-providers ourbigbook.json 400
- openLinksOnNewTabs ourbigbook.json
- outputOutOfTree ourbigbook.json 111
- prepublish ourbigbook.json 90
- publishCommitDate ourbigbook.json 31
- publishOptions ourbigbook.json 62
- publishRemoteUrl ourbigbook.json 32
- redirects ourbigbook.json 188
- template ourbigbook.json 52
- toSplitHeaders ourbigbook.json 80
- web ourbigbook.json 199 4
  - host web 27
  - hostCapitalized web 28
  - linkFromStaticHeaderMetaToWeb web 123
  - username web 11
- xPrefix ourbigbook.json 133

`ourbigbook.json`

 Ancestors (2)

 Incoming links (12)