Skip to content

Documentation pages for IQM's client-side libraries.

Notifications You must be signed in to change notification settings

iqm-finland/docs

Repository files navigation

IQM Docs

This repository exists solely for building and publishing documentation pages for IQM's client-side libraries: https://iqm-finland.github.io/docs/

Building the documentation locally

It uses a Python script in generate_search_index.py to generate a search index for the documentation. To build the documentation locally, you need to have Python installed and then run the script based on the folders, or retrieve a search.json document from the GitHub repository and the GitHub Pages branch.

In order to locally run the React application, you need to have Node.js installed. Then you can run the following commands:

npm install
npm run dev

or use Yarn:

yarn install
yarn  dev