https://github.com/wdullaer/raml2slate

Render the RAML API spec in the slate documentation layout
https://github.com/wdullaer/raml2slate

documentation-generator raml raml2html slate

Last synced: about 1 month ago
JSON representation

Render the RAML API spec in the slate documentation layout

• Host: GitHub
• URL: https://github.com/wdullaer/raml2slate
• Owner: wdullaer
• License: other
• Created: 2016-09-12T10:22:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-20T08:14:56.000Z (over 7 years ago)
• Last Synced: 2024-05-02T00:55:47.724Z (7 months ago)
• Topics: documentation-generator, raml, raml2html, slate
• Language: JavaScript
• Size: 527 KB
• Stars: 8
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# raml2slate [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url] [![Deprecated Badge][deprecated-image]][deprecated-url]

> Render the RAML API spec in the slate documentation layout

## Deprecated

This package has been deprecated in favor of the [raml2html-slate-theme](https://npmjs.com/package/raml2html-slate-theme) for [raml2html](https://npmjs.com/package/raml2html). All future development will happen there.

## Introduction

This package is meant to render nice looking documentation for your REST API, based on a RAML file.

It is inspired by [slate](https://github.com/lord/slate) and [raml2html](https://github.com/raml2html/raml2html).

The package is usable, but the API and templates might still change based upon feedback.

As of v0.0.6 only RAML 1.0 specificiations are supported.

![Example](https://raw.github.com/wdullaer/raml2slate/gh-pages/example-image.png)

## Installation

```sh

$ npm install --save raml2slate

```

## Usage

In javascript:

```js

var raml2slate = require('raml2slate');

raml2slate.render({

  input: 'path/to/raml/file',

  output: 'path/to/output/directory',

  theme: 'path/to/optional/theme/file',

  logo: 'path/to/optional/png/logo'

});

```

On the command line:

```bash

raml2slate \

-i 'path/to/raml/file' \

-o 'path/to/output/directory' \

-t 'path/to/optional/theme/file' \

-l 'path/to/optional/png/logo'

```

You can generate a theme file to tweak using:

```bash

raml2slate --generate-theme > theme.styl

```

## TODO

* Add schema definitions to the template

* Convert render-markdown.js into a metalsmith plugin

* Investigate making this fully compatible with raml2html

## License

Apache-2.0 © [Wouter Dullaert](https://wdullaer.com)

[npm-image]: https://badge.fury.io/js/raml2slate.svg

[npm-url]: https://npmjs.org/package/raml2slate

[travis-image]: https://travis-ci.org/wdullaer/raml2slate.svg?branch=master

[travis-url]: https://travis-ci.org/wdullaer/raml2slate

[daviddm-image]: https://david-dm.org/wdullaer/raml2slate.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/wdullaer/raml2slate

[greenkeeper-image]: https://badges.greenkeeper.io/wdullaer/raml2slate.svg

[greenkeeper-url]: https://greenkeeper.io/

[deprecated-image]: https://img.shields.io/badge/lifecylce-deprecated-orange.svg

[deprecated-url]: https://github.com/wdullaer/raml2html-slate-theme