This repository contains the official documentation for the WiRL framework. WiRL is designed to simplify the implementation of RESTful services in Delphi, while ensuring high interoperability with REST clients written in other languages. Inspired by the JAX-RS specification, WiRL adheres to the six REST constraints and provides a powerful, attribute-based approach to creating RESTful web services using plain Delphi objects.
The WiRL documentation is built using VitePress, a modern, fast static site generator powered by Vite and Vue.js. Below are the steps to set up the environment, build the documentation, and serve it locally.
Make sure you have the following installed on your machine:
- Node.js version 18 or higher.
- Terminal for accessing VitePress via its command line interface (CLI).
-
Clone the Repository:
git clone https://github.com/delphi-blocks/wirl-docs.git cd wirl-docs -
Install Dependencies: You can use npm to install the required packages:
npm install
To run the documentation on a local server for development purposes, use the following command:
npm run docs:devThis will start a local server, and the documentation will be available at http://localhost:5173/. VitePress will automatically reload when changes are made to the documentation files.
To generate a production build of the documentation, run the following command:
npm run docs:buildThis command will create a static version of the site in the docs/.vitepress/dist directory, which can then be deployed to any static hosting service.
We welcome contributions to both the WiRL documentation and its underlying build process. If you have suggestions or improvements, feel free to open a pull request or file an issue. Let’s work together to keep the documentation clear and up-to-date!
For more information about WiRL, please visit the main WiRL repository.