{"id":13469008,"url":"https://github.com/prisma/dataguide","last_synced_at":"2025-04-04T20:09:24.081Z","repository":{"id":37003745,"uuid":"262005933","full_name":"prisma/dataguide","owner":"prisma","description":"🗄️ Prisma's Data Guide - A growing library of articles focused on making databases more approachable.","archived":false,"fork":false,"pushed_at":"2025-03-07T09:55:18.000Z","size":74896,"stargazers_count":156,"open_issues_count":17,"forks_count":52,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-03-28T19:07:40.187Z","etag":null,"topics":["database","mysql","postgresql","prisma"],"latest_commit_sha":null,"homepage":"https://www.prisma.io/dataguide/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prisma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"authors.json","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-07T09:23:26.000Z","updated_at":"2025-03-07T09:55:20.000Z","dependencies_parsed_at":"2023-01-17T12:47:44.908Z","dependency_job_id":"34c68bc2-98e4-4e5f-af5e-fa9802f706dd","html_url":"https://github.com/prisma/dataguide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdataguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdataguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdataguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdataguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prisma","download_url":"https://codeload.github.com/prisma/dataguide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242678,"owners_count":20907134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","mysql","postgresql","prisma"],"created_at":"2024-07-31T15:01:24.140Z","updated_at":"2025-04-04T20:09:24.033Z","avatar_url":"https://github.com/prisma.png","language":"MDX","funding_links":[],"categories":["MDX"],"sub_categories":[],"readme":"# Prisma's Data Guide\n\nThis repository contains the [source code](./src) and the [content](./content) for [Prisma's Data Guide](https://www.prisma.io/dataguide).\n\n## Licenses\n\nThe code in this repository is licensed under an [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n\nThe [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/).\n\n## Run locally\n\nDownload the code and get started by running the following commands:\n\n```\ngit clone git@github.com:prisma/dataguide.git\ncd dataguide\nnpm install\nnpm run dev\n```\n\nTo prettify or format the code, run:\n\n```\nnpm run prettify\n```\n\nVisit `http://localhost:8000/` to view the app.\n\n## MDX blocks\n\nView the example MDX blocks on `http://localhost:8000/intro/example` and the usage in [example.mdx](./content/01-intro/99-example.mdx)\n\n## Configure\n\nWrite MDX files in `content` folder.\n\nOpen [`config.js`](./config.js) for available config options for `gatsby`, `header`, `footer`, `feedback` and `siteMetadata`\n\n## Inserting, moving and deleting files\n\nAll 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).\n\n### Install\n\n```bash\nwget https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool -qO /usr/local/bin/mdtool\nchmod +x /usr/local/bin/mdtool\n```\n\n### Usage\n\n#### Overview\n\n```\nmdtool insert 3\nmdtool swap A B\nmdtool move A B\nmdtool remove 4\n```\n\n#### `mdtool insert`\n\nMake place for a new file at given index and increment all numbers by one after that index:\n\n```\n$ mdtool insert INDEX\n\n# e.g.:\n$ mdtool insert 2\n\n# 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\n```\n\n#### `mdtool swap`\n\nSwap two files; specify both filenames (prefix numbers get automatically adjusted):\n\n```\n$ mdtool swap FILENAME1 FILENAME2\n\n# e.g.:\n$ mdtool swap 03-file1.mdx 07-file2.mdx\n\n# Result: Files are now named: 03-file2.mdx 07-file1.mdx\n```\n\n#### `mdtool move`\n\nMove a given file to another given index\n\n```\n$ mdtool move FILENAME INDEX\n\n# e.g.:\n$ mdtool move 05-file.mdx 2\n\n# Result: 05-file.mdx is move to 02-file.mdx, plus previous files 02-*, 03-*, 04-* are incremented\n```\n\n#### `mdtool remove`\n\nShift all other items by -1 at a given index:\n\n```\n$ mdtool remove INDEX\n\n# e.g.:\n$ mdtool remove 2\n\n# 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\n```\n\n#### Thanks Luca\n\n![](https://imgur.com/LJ0FGHk.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Fdataguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprisma%2Fdataguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Fdataguide/lists"}