Skip to content

Commit 3a2a282

Browse files
committed
Re-establish terminusdb.com/docs
1 parent cb376b4 commit 3a2a282

File tree

10 files changed

+1746
-1084
lines changed

10 files changed

+1746
-1084
lines changed

.env-template

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
TERMINUSDB_API_TOKEN=1234
2+
TERMINUSDB_API_ENDPOINT=https://cloud.terminusdb.com/TerminatorsX
3+
TERMINUSDB_TEAM=TerminatorsX
4+
TERMINUSDB_DB=terminusCMS_docs
5+

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
#
3+
#
4+
.next
5+
.env
26

37
# dependencies
48
/node_modules

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,26 @@ The static TerminusCMS and TerminusDB documentation that can be found on
44
https://terminusdb.com/docs . It is written in NextJS and can be build
55
by running `npm run build`. Note that the API key is needed for access
66
to the data product.
7+
8+
## Schema and documentation snapshot
9+
10+
A documentation snapshot can be generated by running the crawler:
11+
12+
```sh
13+
./run-crawler.sh --assets-domain assets.terminusdb.com --max-pages 200 --download-media
14+
```
15+
16+
This will generate a `all_documents.json` file in the `output` directory.
17+
18+
## Schema
19+
20+
The schema for the documentation snapshot is located in the `schema` directory, together with an example of the output and a copy of the menu-structure based on the CMS schema published in the Terminusdb blogposts and based on the generated json files on terminusdb.com/docs in the NEXT hydration section with minor edits.
21+
22+
## Menu structure
23+
24+
The menu structure is located in the `menu-structure.json` file in the `schema` directory and can be loaded directly into TerminusDB using the schema.
25+
26+
## Media
27+
28+
Media files can be downloaded using the command above.
29+

crawl-docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.js

0 commit comments

Comments
 (0)