https://github.com/canjs/bit-docs-html-canjs

The plugins to produce CanJS.com
https://github.com/canjs/bit-docs-html-canjs

Last synced: about 1 year ago
JSON representation

The plugins to produce CanJS.com

• Host: GitHub
• URL: https://github.com/canjs/bit-docs-html-canjs
• Owner: canjs
• License: mit
• Created: 2016-06-16T21:56:33.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2020-12-28T18:03:40.000Z (over 5 years ago)
• Last Synced: 2024-10-08T09:33:44.166Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/bit-docs-html-canjs
• Size: 5.32 MB
• Stars: 7
• Watchers: 16
• Forks: 0
• Open Issues: 40
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# bit-docs-html-canjs

[![Sauce Labs Test Status](https://saucelabs.com/browser-matrix/bit-docs-html-canjs.svg)](https://saucelabs.com/u/bit-docs-html-canjs)

[![Build Status](https://travis-ci.org/canjs/bit-docs-html-canjs.svg?branch=master)](https://travis-ci.org/canjs/bit-docs-html-canjs)

[![npm version](https://badge.fury.io/js/bit-docs-html-canjs.svg)](https://www.npmjs.com/package/bit-docs-html-canjs)

## Initial install:

```

npm install

```

## Generate example site:

```

npm start

```

## Start a simple server:

```

http-server

```

Site will be available at `http://127.0.0.1:8080/`

## Change Styles

```

npm run styles

```

## Use this in main CanJS.

1. open _package.json_, increment the version number.

2. commit and push to master.

3. run `npm publish`

4. Open _canjs/package.json_. Update `"bit-docs-html-canjs"`'s version.

5. In canjs, run `./node_modules/.bin/bit-docs -df`