Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phadej/ljs

Generate docs from your source
https://github.com/phadej/ljs

Last synced: 10 days ago
JSON representation

Generate docs from your source

Host: GitHub
URL: https://github.com/phadej/ljs
Owner: phadej
License: mit
Created: 2014-03-25T04:53:33.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2019-11-07T17:26:40.000Z (almost 5 years ago)
Last Synced: 2024-10-11T23:53:20.234Z (26 days ago)
Language: JavaScript
Size: 24.4 KB
Stars: 9
Watchers: 3
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# ljs

> Generate docs from your source

[![Build Status](https://travis-ci.org/phadej/grunt-literate.svg)](https://travis-ci.org/phadej/ljs)
[![NPM version](https://badge.fury.io/js/ljs.svg)](http://badge.fury.io/js/ljs)
[![Dependency Status](https://gemnasium.com/phadej/ljs.svg)](https://gemnasium.com/phadej/ljs)
[![Code Climate](https://img.shields.io/codeclimate/github/phadej/ljs.svg)](https://codeclimate.com/github/phadej/ljs)

## command line

If `ljs` is installed globally,
you can use `ljs` command line tool to process your literate javascript files

```sh
$ ljs -c -o foo.md foo.js
$ ljs --help
```

### library

You can also use *grunt-literate* as a normal library:

```js
var documentation = require("grunt-literate")("hello.js", { code: true });
```

## Release History

- **0.3.2** — *2015-08-30* — Dependencies update
- **0.3.1** — *2014-12-21* — Dependencies update
- **0.3.0** — *2014-12-21* — `--no-code` & `--no-meld`
- **0.2.5** — *2014-10-11* — Use eslint and jscs. Update underscore
- **0.2.4** — *2014-07-18* — Use commander
- **0.2.3** — *2014-07-03* — Strip only empty lines from beginning of code blocks
- **0.2.2** — *2014-07-02* — Whitespace handling for included files
- **0.2.1** — *2014-07-01* — Dependencies update
- **0.2.0** — *2014-05-25* — Initial release
- Split out of [grunt-literate](https://github.com/phadej/grunt-literate) 0.1.5

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality.
Lint and test your code using [Grunt](http://gruntjs.com/).
Make a pull request, but don't commit `README.md`!

## Related work

This task could be abused to do literate programming.
[Docco](http://jashkenas.github.io/docco/) is similar tool,
however *ljs* is markup-language-agnostic.

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.