Playmate Sports Documentation

Welcome to the Playmate Sports documentation. Use the navigation menu to browse through different sections of the documentation.

The code behind this documentation is stored in the playmate-sports repository. To edit a specific page, you can perform the changes directly in the repository under the docs directory.

Running the Documentation Locally

The documentation is built using DocFx, which generates a static site based on Markdown files.

To run the documentation site locally, follow these steps:

1. Navigate to the docs directory in the repository
2. Run the setup-docfx.js script to ensure you have DocFx installed:

   node setup-docfx.js
   

3. Run the build-docs.js script to build the site:

   node build-docs.js
   

4. Run the run-docs.js script to serve the site:

   node run-docs.js
   

5. Navigate to http://localhost:8080 to view the site