Skip to content

dub-lin/docs-1

This branch is 20 commits behind platformatic/docs:main.

Folders and files

NameName
Last commit message
Last commit date
Nov 7, 2024
Dec 23, 2024
Aug 24, 2024
Oct 17, 2024
Dec 3, 2024
Sep 30, 2024
Aug 24, 2024
Jan 2, 2025
Jan 2, 2025
Jul 19, 2024
Jun 7, 2023
Aug 24, 2024
Oct 4, 2024
Jul 19, 2024
Dec 2, 2024
Aug 24, 2024
Nov 27, 2024
Nov 27, 2024
Aug 24, 2024
Dec 11, 2024
Sep 24, 2024
Sep 11, 2024
Jan 2, 2025

Repository files navigation

Platformatic Documentation

This website is built using Docusaurus 3, a modern static website generator.

Where is the documentation?

The documentation is hosted in the Platformatic repository.

Setting up the development environment

  1. Create a working directory and navigate into it

mkdir /workdir
cd /workdir
  1. Clone the Platformatic repositories

# Clone the main Platformatic repository
git clone https://github.com/platformatic/platformatic.git

# Clone the Docs repository
git clone https://github.com/platformatic/docs.git

After cloning, your working directory (/workdir) should contain:

  • /platformatic
  • /docs
  1. Install dependencies in both repositories

Navigate to each directory and run npm install:

# Install dependencies in the platformatic repository
cd platformatic
npm install
cd ..

# Install dependencies in the docs repository
cd docs
npm install
cd ..
  1. Navigate to the docs directory

cd docs

Running the Development Server

Step 1: Setup the docs environment variable

# This sets the DOCS variable to the docs directory within the cloned Platformatic repository
export DOCS=`realpath $PWD/../platformatic/docs`

Step 2: Start the development server

npm run sync-and-start

Deploy

Deployment is managed automatically through GitHub Actions. Check the workflow configurations in the .github folder within the OSS directory for details.

Generate docs for an old Platformatic version

We keep online only the last version of each Platformatic major version (excluding version 0.x). Every time a new version is released, this repository is tagged with vX.Y.Z.

To generate the documentation for a specific version, checkout the related tag and run the development server.

Known issues

Deleting directories

Deleting directories within ./docs may cause Docusaurus to crash. If this happens, stop the server (Ctrl+C) and restart it.

About

Documentation website for Platformatic

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 92.4%
  • CSS 7.6%