{"id":19352009,"url":"https://github.com/serverpod/serverpod_docs","last_synced_at":"2025-10-28T11:06:02.789Z","repository":{"id":42206076,"uuid":"472508956","full_name":"serverpod/serverpod_docs","owner":"serverpod","description":"Serverpod's official documentation.","archived":false,"fork":false,"pushed_at":"2025-04-16T15:25:10.000Z","size":9088,"stargazers_count":26,"open_issues_count":5,"forks_count":69,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-20T09:59:07.525Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverpod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-03-21T20:54:14.000Z","updated_at":"2025-04-16T12:49:31.000Z","dependencies_parsed_at":"2023-02-16T10:01:46.294Z","dependency_job_id":"e90d6bfa-7711-418d-8418-c43c506f54e0","html_url":"https://github.com/serverpod/serverpod_docs","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/serverpod%2Fserverpod_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverpod%2Fserverpod_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverpod","download_url":"https://codeload.github.com/serverpod/serverpod_docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250391152,"owners_count":21422849,"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":[],"created_at":"2024-11-10T04:37:51.245Z","updated_at":"2025-10-28T11:06:02.783Z","avatar_url":"https://github.com/serverpod.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverpod documentation website\n\nThis is the code for Serverpod's official documentation. If you are contributing, please only edit files in the `docs` directory. The Serverpod team will handle any updates to existing versions if necessary. You can view the updated documentation by choosing the _Next_ option in the top menu bar.\n\nWe have a Makefile with all the common commands, but you can also work with npm directly.\n\n### Using the Makefile\n\nThe project includes a Makefile that provides shortcuts for common tasks. You can see all available commands by running:\n\n```bash\n$ make help\n```\n\nThis will display a list of all available commands and their descriptions. The Makefile includes commands for installation, starting the development server, creating versions, formatting markdown files, and cleaning build artifacts.\n\n### Install\n\nMake sure that you have Node.js installed on your computer.\n\n```bash\n$ cd serverpod_docs\n\n# Using npm\n$ npm install\n\n# Or if you have Make installed, use this make command\n$ make install\n```\n\n### Local Development\n\n```bash\n# Using npm\n$ npm start\n\n# Or if you have Make installed, use this make command\n$ make start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Add version\n\nMake sure that the documentation is all up-to-date then run:\n\n```bash\n# Using npm\n$ npm run docusaurus docs:version X.X.X\n\n# Or if you have Make installed, use this make command\n$ make version VERSION=X.X.X\n```\n\n### Amend the latest version\n\nIf you need to make changes to the latest version, you can do so by removing the latest version from `versions.json` and adding it again running the create version command with the same version number.\n\n```bash\n# Using npm\n$ npm run docusaurus docs:version X.X.X\n\n# Or if you have Make installed, use this make command\n$ make version VERSION=X.X.X\n```\n\n### Add redirects\n\nTo maintain link integrity when relocating or renaming documentation pages, it's recommended to implement redirects. This is facilitated by the `@docusaurus/plugin-client-redirects` plugin. Redirects can be configured in the `docusaurus.config.js` file, within the `redirects` section of the plugin configuration.\n\n### Deploy\n\nOnce a PR is merged into the `main` branch of this repository, a GitHub action is triggered that builds the documentation and pushes the build to the `docs` directory within the `serverpod.github.io` repository. The built documentation is committed as a new commit to the `main` branch and is then deployed to Github pages by the `serverpod.github.io` repository.\n\n### Formatting\n\nTo ensure consistent formatting, we use markdownlint [(VS Code Extension)](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)\n\nInstall the `markdownlint-cli` globally, by running the following command from your terminal:\n\n```bash\n# Using npm\n$ npm install -g markdownlint-cli\n\n# Or if you have Make installed, use this make command\n$ make install-linter\n```\n\nFormatting is only enforced in `/serverpod_docs/docs/` directory so therefore you only need to run the markdownlint-cli in this folder with:\n\n```bash\n# Using npm\n$ markdownlint './docs/**/*.md'\n\n# Or if you have Make installed, use this make command\n$ make format\n```\n\n### Manual build and deploy\n\nTo do this you need access to the Serverpod Github `serverpod.github.io` repository. Clone it next to the `serverpod_web` repo.\n\n```bash\n$ util/deploy\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverpod%2Fserverpod_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverpod%2Fserverpod_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverpod%2Fserverpod_docs/lists"}