pepone / icerpc-docs

Documentation site for IceRPC

IceRPC Docs

This repository contains the source code and markdown files for the IceRPC documentation site.

Build Requirements

You'll need Node.js and npm installed to build the documentation site. To install node, it is recommended to follow the guide provided by Node.js here.

Building

1. Install Dependencies: Run the following command to install the necessary packages.

   npm install

2. Start the Development Server: Use the command below to start the dev server.

   npm run dev

Writing Documentation

For comprehensive guidelines on writing documentation, including how to use custom nodes and tags, please refer to the Writing Documentation page.

Generating a PDF

This repository provides a tool for generating a PDFs from the documentation using puppeteer. To run the tool, use the following commands:

cd tools/pdf
npm install
npm run generate-pdf