https://github.com/serverpod/serverpod_docs

Serverpod's official documentation.
https://github.com/serverpod/serverpod_docs

Last synced: 2 months ago
JSON representation

Serverpod's official documentation.

• Host: GitHub
• URL: https://github.com/serverpod/serverpod_docs
• Owner: serverpod
• Created: 2022-03-21T20:54:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T10:38:02.000Z (9 months ago)
• Last Synced: 2024-04-11T11:41:07.487Z (9 months ago)
• Language: MDX
• Homepage:
• Size: 6.96 MB
• Stars: 12
• Watchers: 3
• Forks: 43
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Serverpod documentation website

This 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.

### Install

Make sure that you have Node.js installed on your computer.

```bash

$ cd serverpod_docs

$ npm install

```

### Local Development

```bash

$ npm start

```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Add version

Make sure that the documentation is all up-to-date then run:

```bash

npm run docusaurus docs:version X.X.X

```

### Amend the latest version

If 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.

```bash

npm run docusaurus docs:version X.X.X

```

### Add redirects

To 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.

### Deploy

Once 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.

### Formatting

To ensure consistent formatting, we use markdownlint [(VS Code Extension)](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)

Install the `markdownlint-cli` globally, by running the following command from your terminal:

```bash

$ npm install -g markdownlint-cli

```

Formatting is only enforced in `/serverpod_docs/docs/` directory so therefore you only need to run the markdownlint-cli in this folder with:

```bash

$ markdownlint './docs/**/*.md'

```

### Manual build and deploy

To do this you need access to the Serverpod Github `serverpod.github.io` repository. Clone it next to the `serverpod_web` repo.

```bash

$ util/deploy

```