Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prisma/dataguide
🗄️ Prisma's Data Guide - A growing library of articles focused on making databases more approachable.
https://github.com/prisma/dataguide
database mysql postgresql prisma
Last synced: 12 days ago
JSON representation
🗄️ Prisma's Data Guide - A growing library of articles focused on making databases more approachable.
- Host: GitHub
- URL: https://github.com/prisma/dataguide
- Owner: prisma
- License: apache-2.0
- Created: 2020-05-07T09:23:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T14:00:18.000Z (20 days ago)
- Last Synced: 2024-10-21T22:55:27.059Z (20 days ago)
- Topics: database, mysql, postgresql, prisma
- Language: MDX
- Homepage: https://www.prisma.io/dataguide/
- Size: 71.4 MB
- Stars: 156
- Watchers: 19
- Forks: 49
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
- Authors: authors.json
Awesome Lists containing this project
README
# Prisma's Data Guide
This repository contains the [source code](./src) and the [content](./content) for [Prisma's Data Guide](https://www.prisma.io/dataguide).
## Licenses
The code in this repository is licensed under an [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
The [written content](./content/) is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
## Run locally
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
```
To prettify or format the code, run:
```
npm run prettify
```
Visit `http://localhost:8000/` to view the app.
## MDX blocks
View the example MDX blocks on `http://localhost:8000/intro/example` and the usage in [example.mdx](./content/01-intro/99-example.mdx)
## Configure
Write MDX files in `content` folder.
Open [`config.js`](./config.js) for available config options for `gatsby`, `header`, `footer`, `feedback` and `siteMetadata`
## 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](https://github.com/steebchen/), you can perform these operations with a dedicated CLI called [`mdtool`](https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool).
### Install
```bash
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
