docs.codefresh.io

This site is built with Jekyll. Documentation content is written in Markdown format located in './docs'

Deploying

The site is automatically deployed when commits are merged/pushed in master, hosted at https://codefresh.io/docs/

Preview documentation locally with Docker (Recommended)

1. Install docker-compose
2. Run docker-compose up
3. Open http://localhost:3131 in your browser, and voila!

To compile scss files into css run the command npm run css or in the live mode npm run watch-css. To compile js files into a bundle run the command npm run js or in the live mode npm run watch-js. Node version 9.11.2

Preview documentation locally (Legacy method)

1. Install Ruby, bundler, jekyll and other Ruby dependencies with bundle install.
2. Run npm install to install Node.js dependencies.
3. Run npm run css (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
4. From the root directory, run npm run docs-serve-dev in the command line.
5. Open http://localhost:19002 in your browser, and voila.