Chewie is a Node.js module that can be used in any skeleton build by any static site generator. It supports approach for documentation that is contradictory to main documentation trend called single source publishing. Chewie makes it possible to have the content distributend in different locations, we could name it distributed source publishing.

What does it mean in practice. You can imagine your product consists of 40 different documentation topics. You can document them all in one portal using static site generator, but the content keep in 40 different repositories and managed by different teams using git.

Table of Contents

• Installation
• Usage
• Quick Start
• Create Documentation
• How to Release
• Development
• License
• Defects and Feedback
• Contribution
• Credits

Installation

npm install chewie

Usage

Quick Start

One of many tools, that you can use, is for example gulp.js. To use chewie with gulp.js, in the gulp file add:

const chewie = require('chewie');

Create Documentation

sudo npm install -g jsdoc
jsdoc -r src -d documentation

Open index.html under apidocs/documentation

How to Release

You need to have proper NPM permissions to release this project. Run this command to release:

npm run release

NOTE: This command increments the package version by 0.0.1 (patch). To release new minor or major version, modify bump-version script in the package.json file. Replace patch with minor or major.

Development

• To run all tests, use the following command:

  DOCU_PROVIDER=GIT NODE_ENV=master npm run test-unit && npm run test-integration
  

• To run just one specific test, use one of the following command:

  DOCU_PROVIDER=GIT NODE_ENV=master ./node_modules/mocha/bin/mocha --harmony_shipping test/unit/NAME_OF_THE_UNIT_TEST.spec.js
  

  DOCU_PROVIDER=GIT NODE_ENV=master ./node_modules/mocha/bin/mocha --timeout 40000 --harmony_shipping test/integration/NAME_OF_THE_INTEGRATION_TEST.spec.js
  

License

Copyright (c) 2014 SAP SE or an SAP affiliate company. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License here: LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defects and Feedback

Use the Github issue tracker for now.

Contribution

Read the CONTRIBUTING so you know exactly how to contribute to this project.

Credits

❤️ from the GitHub team @ YaaS