The main entry point for the JavaScript API is the ourbigbook.convert function.
An example can be seen under lib_hello.js.
Note that while doing a simple conversion is easy, things get harder if you want to take multi-file features in consideration, notably cross file reference internals.
This is because these features require interacting with the ID database, and we don't do that from the default ourbigbook.convert API because different deployments will have very different implementations, notably:
  • local Node.js run uses SQLite, an implementation can be seen in the ourbigbook file class SqliteDbProvider
  • the in-browser version that runs in the browser editor of the OurBigBook Web makes API calls to the server

Ancestors