diff --git a/packages/docs/concepts/lowdefy-schema.yaml b/packages/docs/concepts/lowdefy-schema.yaml index 75264a52f3..1f9e587b4b 100644 --- a/packages/docs/concepts/lowdefy-schema.yaml +++ b/packages/docs/concepts/lowdefy-schema.yaml @@ -75,46 +75,46 @@ _ref: type: MarkdownWithCode properties: content: | - # Config + ## Config The config object has the following properties: - `basePath: string`: Set the base path to serve the Lowdefy application from. This will route all pages under `https://example.com//` instead of the default `https://example.com/`. The basePath value must start with "/". - `homePageId: string`: The pageId of the page that should be loaded when a user loads the app without a pageId in the url route. This is the page that is loaded when you navigate to `yourdomain.com`. - # Auth + ## Auth - TODO: Add auth things here + [TODO]: <> (# TODO: Add auth things here) - # Global + ## Global Any data that you wish to use in your app can be stored in the __global__ object, and accessed using the [`_global`](/_global) operator. This is a good place to store data or configuration that is used throughout the app, for example the url of a logo or configuration of a page, since then these are only written once, and can be updated easily. The global object can also be modified using the [`SetGlobal`](/SetGlobal) action. - # Connections + ## Connections In a Lowdefy app you can integrate with other services like API's or databases using `connections` and `requests`. Connections configure the connection settings to the service, and often contain parameters like connection strings, urls and secrets such as passwords or API keys. Requests are used to interact with the connection, for example inserting a data record, executing a query or calling a API end-point. See more about how `connections` and `requests` are used together [here](/connections-and-requests). - # Plugins + ## Plugins - TODO: Add plugin things here + [TODO]: <> (# TODO: Add plugins things here) - # Menus + ## Menus Menu objects are objects with links to pages. They are filtered to only show pages that the user is authorized to see and are used by blocks such as `PageSiderMenu` to render the links in the menu. If no menus are provided, a default menu is created, with links to all of the defined pages, and with their pageIds as menu item titles. See more about how menu objects are used and defined [here](/menus). - # Pages + ## Pages Pages in a Lowdefy app are actually just blocks, the building blocks of a Lowdefy app, with a few extra restrictions and features. Each page should have an `id` that is unique among all pages in the app. Each page is served with the `pageId` as the url route. That is, if you create a page with id `page1`, it will be served at `domain.com/page1`. - TODO: Below will change once we add the head configuration option on pages. Discuss that here. + [TODO]: <> (# TODO: Below will change once we add the head configuration option on pages. Discuss that here.) If `properties.title` is set on a page block, the title will be set as the page title (This is the title displayed on the tabs in your browser). @@ -271,7 +271,7 @@ _ref: In order to keep files neat and generally easier to read and understand, we suggest making use of references and templating. - # References and templates + ## References and templates References are used to split the configuration of an app into logically distinct files, and to reuse configuration in the app. References can be used almost anywhere in the configuration, as long as the configuration remains valid YAML. @@ -279,7 +279,7 @@ _ref: See more about references and templates [here](/references-and-templates). - # Lowdefy versions and version updates + ## Lowdefy versions and version updates Lowdefy is versioned using semantic versioning, with a three part version number, with the form `major.minor.patch`. Lowdefy is in the early stages of development and under active development, with new versions published on a regular basis.