Various improvements: fix mdx generation, css, logo, added search, etc.

Author: obx-vivien

convert_gitbook_to_mdx.py

@@ -4,19 +4,19 @@ import TabItem from "@theme/TabItem"
 
 # Table of contents
 
-* [ObjectBox C / C++ Database](README.md)
-* [Installation](installation.md)
-* [How to get started](getting-started.md)
-* [Entity Annotations](entity-annotations.md)
-* [Generator](generator.md)
-* [Store](store.md)
-* [Queries](queries.md)
-* [Relations](relations.md)
-* [Transactions](transactions.md)
-* [Schema Changes](schema-changes.md)
-* [Time Series Data](time-series-data.md)
-* [Dev Tools and Debugging](dev-tools-and-debugging.md)
-* [FAQ](faq.md)
+* [ObjectBox C / C++ Database](README)
+* [Installation](installation)
+* [How to get started](getting-started)
+* [Entity Annotations](entity-annotations)
+* [Generator](generator)
+* [Store](store)
+* [Queries](queries)
+* [Relations](relations)
+* [Transactions](transactions)
+* [Schema Changes](schema-changes)
+* [Time Series Data](time-series-data)
+* [Dev Tools and Debugging](dev-tools-and-debugging)
+* [FAQ](faq)
 * [GitHub](https://github.com/objectbox/objectbox-c)
 * [ObjectBox Generator](https://github.com/objectbox/objectbox-generator)
 * [C API docs](https://objectbox.io/docfiles/c/current/)

website/README.mdx

@@ -69,7 +69,7 @@ The following annotations are currently supported:
 
 * **name** - specifies the name to use in the database if it's desired to be different than what the FlatBuffer schema "table" is called.
 * **transient** - this entity is skipped, no code is generated for it. Useful if you have custom FlatBuffer handling but still want to generate ObjectBox binding code for some parts of the same file.
-* **uid** - used to explicitly specify UID used with this entity; used when renaming entities. See [Schema changes](schema-changes.md) for more details.
+* **uid** - used to explicitly specify UID used with this entity; used when renaming entities. See [Schema changes](schema-changes) for more details.
 * **relation** - adds a standalone (many-to-many) relation, usually to another entity. Example: creating a relation to the authors of a book: `objectbox:relation(name=authors,to=Author)`
 * **sync** - enables synchronization for the entity - only relevant with [ObjectBox Sync](https://objectbox.io/sync/) library builds. Entities not marked with this annotation will not be synchronized to the server, i.e. they're local-only.
   * `sync(sharedGlobalIds)` can be used to switch from the default behaviour (ID-mapping) to using a global ID space. This flag tells ObjectBox to treat object IDs globally and thus no ID mapping (local `<->` global) is performed. Often this is used with `id(assignable)` annotation and some special ID scheme.
@@ -89,5 +89,5 @@ The following annotations are currently supported:
 * **relation** - declares the field as a relation ID, linking to another Entity which must be specified as a value of this annotation.
 * **name** - specifies the name to use in the database if it's desired to be different than what the FlatBuffer schema "field" is called.
 * **transient** - this property is skipped, no code is generated for it. Useful if you have custom FlatBuffer handling but still want to generate ObjectBox binding code for the entity.
-* **uid** - used to explicitly specify UID used with this property; used when renaming properties. See [Schema changes](schema-changes.md) for more details.
+* **uid** - used to explicitly specify UID used with this property; used when renaming properties. See [Schema changes](schema-changes) for more details.
 * **unique** - set to enforce that values are unique before an entity is inserted/updated. A `put` operation will abort and return an error if the unique constraint is violated.

website/docs/SUMMARY.mdx

@@ -15,12 +15,12 @@ This is the reference guide on the ObjectBox Generator, a build-time tool for Ob
 
 
 :::info
-For an intro to the generator, see also the [installation guide](installation.md#objectbox-generator) and [Generating Binding Code](getting-started.md#generating-binding-code).
+For an intro to the generator, see also the [installation guide](installation#objectbox-generator) and [Generating Binding Code](getting-started#generating-binding-code).
 :::
 
-When using ObjectBox within your project, you typically need two things: the runtime library and the the build-time ObjectBox Generator. The generator takes a data model (see [Entity Annotations](entity-annotations.md)) as input and generates `struct`s, a data model representation as code and additional glue code for a tight and fast integration of your individual data types and the ObjectBox API.
+When using ObjectBox within your project, you typically need two things: the runtime library and the the build-time ObjectBox Generator. The generator takes a data model (see [Entity Annotations](entity-annotations)) as input and generates `struct`s, a data model representation as code and additional glue code for a tight and fast integration of your individual data types and the ObjectBox API.
 
-If you are using CMake, it's highly recommended to use the CMake integration of the ObjectBox Generator. For all other setups, triggering the generator in [standalone mode](generator.md#standalone) is also supported.
+If you are using CMake, it's highly recommended to use the CMake integration of the ObjectBox Generator. For all other setups, triggering the generator in [standalone mode](generator#standalone) is also supported.
 
 :::info
 The ObjectBox Generator binary is currently not available for Linux/Windows ARM architectures (pull requests are welcome). The macOS as universal binary supports ARM64 and AMD64 architectures.
@@ -32,7 +32,7 @@ The ObjectBox Generator is well integrated into CMake. 
 
 Enabling the Generator via CMake
 
-Once you have the ObjectBox runtime library set up via `FetchContent` (see [installation](installation.md)), it only takes one more command to enable the Generator:
+Once you have the ObjectBox runtime library set up via `FetchContent` (see [installation](installation)), it only takes one more command to enable the Generator:
 
 ```cmake
 # Note: downloads automatically if not found locally
@@ -91,7 +91,7 @@ By default, generated files (except the model JSON file) are written relative to
 
 ### Details on finding the CMake module
 
-The CMake module is implicitly downloaded together with objectbox shared libraries as described in [Installation](installation.md).\
+The CMake module is implicitly downloaded together with objectbox shared libraries as described in [Installation](installation).\
 \
 The latest version of the find module is also available from [https://raw.githubusercontent.com/objectbox/objectbox-generator/main/cmake/FindObjectBoxGenerator.cmake](https://raw.githubusercontent.com/objectbox/objectbox-generator/main/cmake/FindObjectBoxGenerator.cmake)
 

website/docs/entity-annotations.mdx

@@ -18,7 +18,7 @@ ObjectBox Generator produces binding code for ObjectBox C & C++ APIs. This great
 ### Generating binding code
 
 :::info
-ObjectBox Generator is a tool, which must be [downloaded separately](https://github.com/objectbox/objectbox-generator/releases). For details, please check the [installation](installation.md) page.
+ObjectBox Generator is a tool, which must be [downloaded separately](https://github.com/objectbox/objectbox-generator/releases). For details, please check the [installation](installation) page.
 :::
 
 ObjectBox Generator uses FlatBuffer schema file (.fbs) as its primary input. The Generator also maintains some metadata around the data model in a JSON file (objectbox-model.json). Based on these two files, it generates code for the selected language (C or C++). 
@@ -52,7 +52,7 @@ The following files will be generated:
 * tasklist.obx.cpp
 
 :::info
-See [#cmake-support](generator.md#cmake-support "mention")for details on CMake integration.
+See [#cmake-support](generator#cmake-support "mention")for details on CMake integration.
 :::
 
 </TabItem>
@@ -233,7 +233,7 @@ handle_error:  // print error and clean up
 
 If you've followed the installation instructions, you should be able to compile the example
 
-If you are using CMake, like shown in the [installation section](installation.md#cmake-3.14),  just add the generated `tasklist.obx.cpp` file to the `myapp`  target.
+If you are using CMake, like shown in the [installation section](installation#cmake-3.14),  just add the generated `tasklist.obx.cpp` file to the `myapp`  target.
 
 The `add_executable` call in the CMake file now looks like this:
 
@@ -263,7 +263,7 @@ gcc main.c -I. -lobjectbox -lflatccrt
 </Tabs>
 
 :::info
-The command snippet assumes you have [the libraries installed](installation.md) in a path recognized by your OS (e.g. /usr/local/lib/) and all the referenced headers are in the same folder alongside the main.c/.cpp file.
+The command snippet assumes you have [the libraries installed](installation) in a path recognized by your OS (e.g. /usr/local/lib/) and all the referenced headers are in the same folder alongside the main.c/.cpp file.
 :::
 
 Wherever you have access to a Box, you can use it to persist objects and fetch objects from disk. **Boxes are thread-safe.** Here are some of the basic operations, have a look at the objectbox.h(pp) for more:

website/docs/generator.mdx

@@ -39,10 +39,7 @@ FetchContent_MakeAvailable(objectbox)
 
 add_executable(myapp main.cpp)
 target_link_libraries(myapp objectbox)
-```
-
-
-
+```cmake
 If you want to use an ObjectBox Sync variant of the library, change the `target_link_libraries` to: 
 
 ```cmake
@@ -73,8 +70,7 @@ endif()
 
 add_executable(myapp main.cpp)
 target_link_libraries(myapp objectbox)
-```
-
+```cmake
 If you want to integrate the ObjectBox-Generator via CMake (as an alternative to offline installation and pre-generation of C++ sources), use the following snippet:
 
 ```cmake
@@ -88,8 +84,7 @@ add_obx_schema(
   INSOURCE # Opt-in: Generate in source directory
   CXX_STANDARD 11 # Defaults to C++14 otherwise
 )
-```
-
+```cmake
 \
 If you want to use an ObjectBox Sync variant of the library, change the list line to: 
 
@@ -204,7 +199,7 @@ Try running `objectbox-generator -help` to verify the installation and see the o
 </TabItem>
 </Tabs>
 
-For more details, please refer to the [Generator documentation page](generator.md).
+For more details, please refer to the [Generator documentation page](generator).
 
 ## FlatBuffers
 
@@ -241,13 +236,13 @@ For special setups, the objectbox.hpp header also allows a configuration, which
 :::
 
 </TabItem>
-<TabItem value="cmake1" label="C without CMake">
+<TabItem value="c" label="C without CMake">
 
 Get [flatcc library and headers](https://github.com/dvidelabs/flatcc). You can link your program to the to the static runtime library.
 
 CMake example (check the link above for the latest version):
 
-```
+```c
 FetchContent_Declare(
     flatcc
     GIT_REPOSITORY https://github.com/dvidelabs/flatcc.git

website/docs/getting-started.mdx

@@ -78,7 +78,7 @@ OBX_bytes_array* bytes_array = obx_query_find(query, 0, 0);
 ```
 
 :::info
-`obx_query_find()` needs to be executed inside an explicit read transaction to avoid data copy while preserving its validity (so that concurrent threads won't change the data while you read it). We're omitting this in the examples to keep them simple, see [Transactions](transactions.md#read-transactions) for more details.
+`obx_query_find()` needs to be executed inside an explicit read transaction to avoid data copy while preserving its validity (so that concurrent threads won't change the data while you read it). We're omitting this in the examples to keep them simple, see [Transactions](transactions#read-transactions) for more details.
 :::
 
 </TabItem>
@@ -210,7 +210,7 @@ users = query.find();
 </TabItem>
 <TabItem value="c" label="C">
 
-```
+```c
 uint64_t offset = 10;
 uint64_t limit = 5;
 OBX_bytes_array* bytes_array = obx_query_find(query, offset, limit);

website/docs/installation.mdx

@@ -16,7 +16,7 @@ The ObjectBox C / C++ database comes with automatic schema migration. Learn all
 
 ObjectBox manages its data model (schema) mostly automatically. The data model is defined by the Entities you define in FlatBuffer schema files. When you **add or remove** entities or properties of your entities, **ObjectBox takes care** of those changes when you launch `objectbox-generator` on the changed `.fbs` file without any further action needed from you.
 
-For other changes like **renaming or changing the type**, ObjectBox needs **extra information** to make things unambiguous. This works using unique identifiers (UIDs) specified by the [uid annotation](entity-annotations.md#supported-annotations), as we will see below.
+For other changes like **renaming or changing the type**, ObjectBox needs **extra information** to make things unambiguous. This works using unique identifiers (UIDs) specified by the [uid annotation](entity-annotations#supported-annotations), as we will see below.
 
 ## Renaming Entities and Properties <a href="#renaming-entities-and-properties" id="renaming-entities-and-properties"></a>
 
@@ -57,7 +57,7 @@ uid annotation value must not be empty:
 ```
 
 :::info
-Note how for a property, the output is slightly different. It's because you have two options, either renaming the property or resetting (clearing) it's stored data. See [Reset data - new UID on a property](schema-changes.md#reset-data-new-uid-on-a-property) for more details.
+Note how for a property, the output is slightly different. It's because you have two options, either renaming the property or resetting (clearing) it's stored data. See [Reset data - new UID on a property](schema-changes#reset-data-new-uid-on-a-property) for more details.
 :::
 
 &#x20;**Step 3:** Apply the UID printed in the error message to your entity/property:

website/docs/queries.mdx

@@ -277,7 +277,7 @@ obx::Store store(options);
 </TabItem>
 <TabItem value="c" label="C">
 
-```
+```c
 OBX_store_options* opt = obx_opt();
 obx_opt_async_max_in_tx_duration(opt, 1000);
 obx_store_open(opt);
@@ -304,7 +304,7 @@ Available options for fine-tuning asynchronous operations:
 
 ### Debug Flags
 
-When debugging or fine-tuning performance you can enable [logging](dev-tools-and-debugging.md#logging) of various events at the info level.
+When debugging or fine-tuning performance you can enable [logging](dev-tools-and-debugging#logging) of various events at the info level.
 
 <Tabs>
 <TabItem value="cpp" label="C++">
@@ -335,8 +335,8 @@ obx_store_open(opt);
 
 Once you created the store, it gives you access to several ways to interact with the data you store in it; aka the database:
 
-* [**Box API**](getting-started.md#working-with-object-boxes)**:** easy to use object-based API with implicit transactions. It is used in combination with the ObjectBox Generator, which generates the source code for data and Box classes. Check the getting started track for examples.
-* [**Query API**](queries.md)**:** In combination with the Box API, you can build powerful queries using the query builder. Once built, query instances can be executed multiple times to retrieve data.&#x20;
-* [**Explicit Transactions**](transactions.md)**:** Often it's a good idea to group several operations into a single "batch", or more precisely, one transaction. Batched transactions are not only faster, but also consider safe state changes for your data.
+* [**Box API**](getting-started#working-with-object-boxes)**:** easy to use object-based API with implicit transactions. It is used in combination with the ObjectBox Generator, which generates the source code for data and Box classes. Check the getting started track for examples.
+* [**Query API**](queries)**:** In combination with the Box API, you can build powerful queries using the query builder. Once built, query instances can be executed multiple times to retrieve data.&#x20;
+* [**Explicit Transactions**](transactions)**:** Often it's a good idea to group several operations into a single "batch", or more precisely, one transaction. Batched transactions are not only faster, but also consider safe state changes for your data.