Prisma's Data Guide

This repository contains the source code and the content for Prisma's Data Guide.

Licenses

The code in this repository is licensed under an Apache License, Version 2.0.

The written content is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Contributing

Read CONTRIBUTING.md for the content standards every change is held to, and AGENTS.md if you are a coding agent.

Run locally

You need Node.js 22.18.0 or later. Download the code and get started by running the following commands:

git clone [email protected]:prisma/dataguide.git
cd dataguide
npm install
npm run dev

Visit http://localhost:8000/ to view the app.

Other commands:

npm test            # unit tests
npm run typecheck   # TypeScript
npm run build       # production build, including the internal link check
npm run prettify    # format the code and content

Every article is also published as Markdown by appending .md to its URL, and /llms.txt lists them all.

MDX blocks

View the example MDX blocks on http://localhost:8000/intro/example and the usage in example.mdx

Configure

Write MDX files in content folder.

Open config.ts for available config options for gatsby, header, footer and siteMetadata, and for the redirects of moved articles.

Inserting, moving and deleting files

All files/folders in the context are prefixed with a position which indicates the order in which they appear in the sidenav on the docs website. This makes it cumbersome to insert, move and delete files because the positions of a number of other files (if not all) in the same folder might need to be adjusted. Thanks to Luca Steeb, you can perform these operations with a dedicated CLI called mdtool.

Install

wget https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool -qO /usr/local/bin/mdtool
chmod +x /usr/local/bin/mdtool

Usage

Overview

mdtool insert 3
mdtool swap A B
mdtool move A B
mdtool remove 4

mdtool insert

Make place for a new file at given index and increment all numbers by one after that index:

$ mdtool insert INDEX

# e.g.:
$ mdtool insert 2

# Result: for files 01-a, 02-b, 03-c, and 04-d; 03-c is renamed to 04-c and 04-d is renamed to 05-d so you can create a new file at index 2

mdtool swap

Swap two files; specify both filenames (prefix numbers get automatically adjusted):

$ mdtool swap FILENAME1 FILENAME2

# e.g.:
$ mdtool swap 03-file1.mdx 07-file2.mdx

# Result: Files are now named: 03-file2.mdx 07-file1.mdx

mdtool move

Move a given file to another given index

$ mdtool move FILENAME INDEX

# e.g.:
$ mdtool move 05-file.mdx 2

# Result: 05-file.mdx is move to 02-file.mdx, plus previous files 02-*, 03-*, 04-* are incremented

mdtool remove

Shift all other items by -1 at a given index:

$ mdtool remove INDEX

# e.g.:
$ mdtool remove 2

# Result: 01-a, 02-b, 03-c, 04-d becomes 01-a, 02-b, 02-c, 03-d; 02-b is supposed to be manually deleted

Thanks Luca