Files
IronCalc/docs/README.md
2024-11-28 22:42:14 +01:00

939 B

IronCalc Docs

This repository contains IronCalc's end-user documentation. Here, you can explore supported features, functions, and more.

Prerequisites

To manage the documentation, we use VitePress, a Static Site Generator (SSG).

First, ensure you have nodejs installed in your system

Installation

Start installing the required dependencies by running the following command in your terminal:

npm install

Running the Project

Start a development instnace of the documentation server with:

npm run dev

After running the command, you can view the documentation in your browser at http://localhost:5173 if the port is available. Making changes to the Markdown will automatically reload your browser.

Build the Project

To deploy the project:

npm run build

The project will be build in src/.vitepress/dist