Skip to content

adamogle/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 

Repository files navigation

API Documentation for Handsontable

Installation

Install the npm dependencies by typing:

npm install

Create a .env.json file in the main directory, and fill it with your Github token data as follows:

{
  "GITHUB_TOKEN": "[insert your gihub token here]"
}

Fetch source code of the Handsontable PRO and CE and build the documentation:

npm run start

If you encounter the Warning: ENOENT: no such file or directory, open 'generated/scripts/doc-versions.js' Use --force to continue. problem, create a generated/scripts directory structure, by typing:

mkdir -p generated/scripts

Building

After the initial documentation setup, you can use the

npm run build

command, to build the documentation without cloning the Handsontable repos.

To preview the documentation run docker-compose:

docker-compose -f docker/docker-compose.yml up

By default the documentation will be available at http://localhost:8085/docs/{your-docs-version}/tutorial-introduction.html.

About

API Documentation for Handsontable

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published