Module Index

Bible Modules contain an index.json file at the root of the module, which provides metadata about the module.

• index.json
• Directoryot/

  • DirectoryGenesis/

    • 1.md
    • …
• Directorynt/

  • DirectoryMatthew/

    • 1.md
    • …

The index file has to contain the following information:

{
    "name": "Name of the translation",
    "description": "Description of the translation",
    "slug": "Shorthand of the Translation, all lowercase, no spaces or special characters",
    "language": "en",
    "booknames": { // Readable names of the books
        "ot": [
          "Genesis",
          // ...
        ],
        "nt": [
          "Matthew",
          // ...
        ],
    },
    "books": { // Paths to the book files
      "ot": [
        "ot/Genesis/",
      ],
      "nt": [
        "nt/Matthew/",
      ]
    }