{"id":13484431,"url":"https://github.com/prisma/docs","last_synced_at":"2025-05-14T04:05:48.329Z","repository":{"id":36957807,"uuid":"246273539","full_name":"prisma/docs","owner":"prisma","description":"📚 Prisma Documentation","archived":false,"fork":false,"pushed_at":"2025-05-13T08:28:30.000Z","size":165695,"stargazers_count":1015,"open_issues_count":32,"forks_count":815,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-05-13T08:31:52.455Z","etag":null,"topics":["docs","prisma","web"],"latest_commit_sha":null,"homepage":"https://www.prisma.io/docs","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":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-10T10:38:43.000Z","updated_at":"2025-05-12T16:18:54.000Z","dependencies_parsed_at":"2023-10-13T00:05:26.783Z","dependency_job_id":"4354419e-74ff-4fdd-b470-01037936177e","html_url":"https://github.com/prisma/docs","commit_stats":{"total_commits":4050,"total_committers":676,"mean_commits":5.991124260355029,"dds":0.8785185185185185,"last_synced_commit":"38b134ef7ed4bddd550b6fd02208438292728328"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prisma","download_url":"https://codeload.github.com/prisma/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254067497,"owners_count":22009198,"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":["docs","prisma","web"],"created_at":"2024-07-31T17:01:24.313Z","updated_at":"2025-05-14T04:05:48.279Z","avatar_url":"https://github.com/prisma.png","language":"MDX","funding_links":[],"categories":["MDX","TypeScript"],"sub_categories":[],"readme":"# Prisma Documentation\n\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/prisma/docs/blob/main/CONTRIBUTING.md) ![Discord](https://img.shields.io/discord/937751382725886062)\n\nThis repository contains the [source code](./src) and the [content](./content) for the [Prisma documentation](https://www.prisma.io/docs).\n\n## Contributing to the docs\n\nNew contributors are welcome! Read through the [contributing guide](CONTRIBUTING.md) to learn how you can contribute to the Prisma documentation.\n\n## Run the docs site locally\n\n1. Clone this repository.\n2. On your computer, open a terminal window in the repository's directory.\n3. Run the following commands:\n\n```\nnpm install\nnpm run start\n```\n\nBe sure to also test building the static site:\n\n```\nnpm run clean \u0026\u0026 npm run build\nnpm run serve\n```\n\nTo prettify or format the code, run:\n\n```\nnpm run format\n```\n\nPlease note that `.md` and `.mdx` files are not formatted by Prettier because they are written in [MDX 3](https://mdxjs.com/blog/v3/) which Prettier [does not support](https://github.com/prettier/prettier/issues/12209).\n\nVisit `http://localhost:3000` to view the app.\n\n## Configure\n\nWrite MDX files in `content` folder.\n\nMost frontmatter for the docs are the same as [Docusaurus Frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter). There are some differences due to legacy frontmatter which are handled [here](https://github.com/prisma/docs/blob/94b04aa1d8f723802e715b531b9808bab2d7ae15/src/theme/DocItem/Metadata/index.tsx).\n\nWhen possible, avoid using custom frontmatter fields and use the default ones available via Docusaurus.\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\nFirst, install `wget`:\n\n```bash\nbrew install wget\n```\n\nThen use `wget` to install `mdtool`:\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://res.cloudinary.com/prismaio/image/upload/v1628765536/docs/LJ0FGHk_u2jjxv.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprisma%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Fdocs/lists"}