You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ A map-centric website backed by a Core Data project and Typesense index.
5
5
## Getting Started
6
6
7
7
#### Requirements
8
+
8
9
- Node 20.x
9
10
- Netlify CLI
10
11
- Core Data Project
@@ -19,6 +20,7 @@ Copy the `.env.example` file to `.env` and enter required variables. For a local
19
20
Add a `/public/config.dev.json` file, which will be ignored by Git, to copy local config settings when starting the application. Use the `config.json` table below to configure your project.
20
21
21
22
To start, run:
23
+
22
24
```
23
25
npm install && netlify dev
24
26
```
@@ -31,7 +33,7 @@ npm install && netlify dev
31
33
32
34
#### Create a content repository
33
35
34
-
On GitHub, create a new content repository. The posts, paths, and pages records you create will be stored here, as well as any i18n, your project configuration, and default user accounts.
36
+
On GitHub, create a new content repository. The posts, paths, and pages records you create will be stored here, as well as any i18n, your project configuration, and default user accounts.
35
37
36
38
###### Directory Structure
37
39
@@ -81,10 +83,10 @@ The `title` attribute will be set as the `<title>` element of the HTML page. Set
81
83
Copy the `/public/config.json` file into your content repository to `/content/settings/config.json` and adjust the configuration as desired.
| content.collections | Array | Array of content keys to allow for data entry and routing: "posts", "paths" |
87
-
| content.localize_pages| Boolean | If `true` pages content will be pulled from a locale directory (e.g. `/en/My-Awesome-Page.mdx`)|
89
+
| content.localize_content| Boolean | If `true` pages and other content will be pulled from a locale directory (e.g. `/en/My-Awesome-Page.mdx`) |
88
90
| core_data | Object | Core Data configuration |
89
91
| core_data.url | String | URL of the Core Data application |
90
92
| core_data.project_ids | Array | Array of Core Data project IDs as strings |
@@ -99,11 +101,11 @@ Copy the `/public/config.json` file into your content repository to `/content/se
99
101
| layers.overlay | Boolean | If `true`, map layer will be rendered as overlay layer. If `false`, map layer will be rendered as base layer |
100
102
| result_filtering | Object | Lists of fields and relationships to exclude per model. |
101
103
| result_filtering.events.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
102
-
| result_filtering.instances.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
104
+
| result_filtering.instances.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
103
105
| result_filtering.items.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
104
-
| result_filtering.organizations.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
105
-
| result_filtering.people.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
106
-
| result_filtering.places.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
106
+
| result_filtering.organizations.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
107
+
| result_filtering.people.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
108
+
| result_filtering.places.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
107
109
| result_filtering.works.exclude | Array | List of attributes, user defined fields and associations to be excluded from the search detail panel and detail pages. See [Search detail filtering](search-detail-filtering.md)|
@@ -208,4 +210,4 @@ An `x-typesense-api-key` header will need to be added to the request.
208
210
209
211
## Core Data Fields and Relationships
210
212
211
-
To find the UUID values for Core Data user-defined fields and relationships, the "Identifier" column can be added to the respective lists within the Core Data application under Project Settings > Configure.
213
+
To find the UUID values for Core Data user-defined fields and relationships, the "Identifier" column can be added to the respective lists within the Core Data application under Project Settings > Configure.
Copy file name to clipboardExpand all lines: docs/configuration-schema.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Array<"paths" | "posts">
18
18
19
19
Required: No
20
20
21
-
### localize_pages
21
+
### localize_content
22
22
23
23
If set to `true`, pages will be nested within a localized directory (e.g `/pages/en/Home.mdx`). If `false`, pages will not be localized and placed in the root `/pages` directory.
0 commit comments