akronix / ramda.github.io

:ram: :globe_with_meridians: Documentation for Ramda.js

ramda.github.io

To generate the various files required by the website, run the following command (using the actual version number in place of X.Y.Z):

$ VERSION=X.Y.Z make

Start local server

This repo contains all the prebuilt files used on the site. It also contains a static file server (available after npm i):

npm run server

Once this is running, visit localhost:8080 to view the docs. In the event that :8080 is in use, you can change the port like so:

npm run server -- -p 8081

For more details on configuring the server, see http-server docs.

What to do on a new release

1. Update package.json to latest version of ramda.

2. Install packages: npm i

3. npm run make_release

Development

Node version

Node 6 or above is required in order to build jsdoc.

If you are using nvm, simply run:

nvm install && nvm use

Building docs

To rebuild the docs page:

npm run jsdoc

Building styles

Styles for the site are written with Less, using the Bootstrap package.

To rebuild the main style.css:

npm run less