{"id":16338983,"url":"https://github.com/phadej/ljs","last_synced_at":"2025-03-22T23:32:53.044Z","repository":{"id":15358242,"uuid":"18089147","full_name":"phadej/ljs","owner":"phadej","description":"Generate docs from your source","archived":false,"fork":false,"pushed_at":"2019-11-07T17:26:40.000Z","size":25,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-01T15:48:41.535Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phadej.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-25T04:53:33.000Z","updated_at":"2021-10-25T20:53:58.000Z","dependencies_parsed_at":"2022-08-30T17:40:34.817Z","dependency_job_id":null,"html_url":"https://github.com/phadej/ljs","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phadej%2Fljs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phadej%2Fljs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phadej%2Fljs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phadej%2Fljs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phadej","download_url":"https://codeload.github.com/phadej/ljs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244250941,"owners_count":20423249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T23:53:14.016Z","updated_at":"2025-03-22T23:32:52.705Z","avatar_url":"https://github.com/phadej.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ljs\n\n\u003e Generate docs from your source\n\n[![Build Status](https://travis-ci.org/phadej/grunt-literate.svg)](https://travis-ci.org/phadej/ljs)\n[![NPM version](https://badge.fury.io/js/ljs.svg)](http://badge.fury.io/js/ljs)\n[![Dependency Status](https://gemnasium.com/phadej/ljs.svg)](https://gemnasium.com/phadej/ljs)\n[![Code Climate](https://img.shields.io/codeclimate/github/phadej/ljs.svg)](https://codeclimate.com/github/phadej/ljs)\n\n## command line\n\nIf `ljs` is installed globally,\nyou can use `ljs` command line tool to process your literate javascript files\n\n```sh\n$ ljs -c -o foo.md foo.js\n$ ljs --help\n```\n\n### library\n\nYou can also use *grunt-literate* as a normal library:\n\n```js\nvar documentation = require(\"grunt-literate\")(\"hello.js\", { code: true });\n```\n\n## Release History\n\n- **0.3.2** \u0026mdash; *2015-08-30* \u0026mdash; Dependencies update\n- **0.3.1** \u0026mdash; *2014-12-21* \u0026mdash; Dependencies update\n- **0.3.0** \u0026mdash; *2014-12-21* \u0026mdash; `--no-code` \u0026amp; `--no-meld`\n- **0.2.5** \u0026mdash; *2014-10-11* \u0026mdash; Use eslint and jscs. Update underscore\n- **0.2.4** \u0026mdash; *2014-07-18* \u0026mdash; Use commander\n- **0.2.3** \u0026mdash; *2014-07-03* \u0026mdash; Strip only empty lines from beginning of code blocks\n- **0.2.2** \u0026mdash; *2014-07-02* \u0026mdash; Whitespace handling for included files\n- **0.2.1** \u0026mdash; *2014-07-01* \u0026mdash; Dependencies update\n- **0.2.0** \u0026mdash; *2014-05-25* \u0026mdash; Initial release\n\t- Split out of [grunt-literate](https://github.com/phadej/grunt-literate) 0.1.5\n\n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding style.\nAdd unit tests for any new or changed functionality.\nLint and test your code using [Grunt](http://gruntjs.com/).\nMake a pull request, but don't commit `README.md`!\n\n## Related work\n\nThis task could be abused to do literate programming.\n[Docco](http://jashkenas.github.io/docco/) is similar tool,\nhowever *ljs* is markup-language-agnostic.\n\nThe MIT License (MIT)\n\nCopyright (c) 2013, 2014 Oleg Grenrus\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphadej%2Fljs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphadej%2Fljs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphadej%2Fljs/lists"}