https://github.com/codefresh-io/cap-docs.codefresh.io

https://github.com/codefresh-io/cap-docs.codefresh.io

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/codefresh-io/cap-docs.codefresh.io
• Owner: codefresh-io
• License: mit
• Created: 2021-11-18T11:05:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-17T08:20:26.000Z (about 3 years ago)
• Last Synced: 2025-04-25T14:59:40.763Z (about 1 year ago)
• Language: SCSS
• Size: 118 MB
• Stars: 6
• Watchers: 10
• Forks: 13
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# docs.codefresh.io

[![Codefresh build status]( https://g.codefresh.io/api/badges/pipeline/codefresh-inc/codefresh-io%2Fdocs.codefresh.io%2Flive-docs?branch=master&key=eyJhbGciOiJIUzI1NiJ9.NTY3MmQ4ZGViNjcyNGI2ZTM1OWFkZjYy.AN2wExsAsq7FseTbVxxWls8muNx_bBUnQWQVS8IgDTI&type=cf-1)]( https://g.codefresh.io/pipelines/live-docs/builds?repoOwner=codefresh-io&repoName=docs.codefresh.io&serviceName=codefresh-io%2Fdocs.codefresh.io&filter=trigger:build~Build;branch:master;pipeline:5a941be91a89c60001c3fad4~live-docs)

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](https://docs.docker.com/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.