{"id":19552461,"url":"https://github.com/pixeldroid/lsdoc","last_synced_at":"2025-10-06T11:32:37.016Z","repository":{"id":141770893,"uuid":"76521605","full_name":"pixeldroid/lsdoc","owner":"pixeldroid","description":"generate API documentation from doc comments in LoomScript source code","archived":false,"fork":false,"pushed_at":"2018-12-04T02:58:44.000Z","size":1916,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-08T20:32:36.426Z","etag":null,"topics":["docs-generator","documentation-tool","gh-pages","jekyll","loom","loomlib","loomscript"],"latest_commit_sha":null,"homepage":"https://pixeldroid.com/lsdoc/","language":"LoomScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pixeldroid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-15T03:45:32.000Z","updated_at":"2024-10-27T00:24:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"be27f026-dcd4-4e55-9faa-b0746ffb7d59","html_url":"https://github.com/pixeldroid/lsdoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Flsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Flsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Flsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Flsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixeldroid","download_url":"https://codeload.github.com/pixeldroid/lsdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240807854,"owners_count":19860818,"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":["docs-generator","documentation-tool","gh-pages","jekyll","loom","loomlib","loomscript"],"created_at":"2024-11-11T04:18:15.710Z","updated_at":"2025-10-06T11:32:31.983Z","avatar_url":"https://github.com/pixeldroid.png","language":"LoomScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lsdoc\n\nan API docs generator for [LoomScript][loomscript]\n\n\u003e _see **lsdoc** api documentation documented by **lsdoc** here: https://pixeldroid.github.io/lsdoc/_ \u003cbr/\u003e\n\n\u003cbr/\u003e\n\n**lsdoc** provides an API for loading loomlib libraries and extracting type metadata.\nThe distribution provides a command line tool for generating documentation compatible with the [programming-pages] theme for creating html documentation that is searchable, browsable, cross-linked, and mobile friendly.\n\n- [installation](#installation)\n- [usage](#usage)\n- [building](#building)\n- [contributing](#contributing)\n\n\n## installation\n\n### lsdoc commandline doc generator\n\n\u003e requires [Rake][rake]\n\nClone this repo.\n\n0. Run `rake cli:install` to:\n    * build and install the `lsdoc` executable onto the system (`/Users/\u003cuser\u003e/bin/lsdoc`)\n0. Run `rake cli:uninstall` to:\n    * remove the `lsdoc` executable from the system\n\n\n## usage\n\ndirectly from the command line:\n\n    $ lsdoc --help\n\nfrom any Loom project using [loomtasks][loomtasks] (including this one):\n\n    $ rake docs\n\nthe **lsdoc** loomlib can also be linked into your own Loom project to leverage the [lsdoc API][lsdoc-api] and build your own documentation tool.\n\n\n## building\n\nfirst, install [loomtasks][loomtasks] and [bundler][bundler].\n\nthen run `bundle install` to retrieve and install the project dependencies on [Jekyll][jekyll] and the [GitHub Pages gem][ghpages-gem]\n\n### compiling from source and installing for use\n\n    $ rake cli:install\n\nthis will build the lsdoc library, install it in the currently configured sdk, build the command line tool and install it on the path\n\n### running tests\n\n    $ rake test\n\nthis will build the lsdoc library, install it in the currently configured sdk, build the test app, and run the test app.\n\n### running the demo\n\u003e from the project root, before installed on the system\n\n    $ export LSDOC=`pwd`\n    $ export LSDK=\"$HOME/.loom/sdks/sprint34\"\n    $ rake clean \u0026\u0026 rake cli['-p ghpages -l $LSDK/libs/LSDoc.loomlib -o $LSDOC/docs']\n\nafter tested and installed, invoke in the usual manner:\n\n    $ lsdoc \u003cargs\u003e\n\n### building and serving the docs\n\n    $ rake docs\n\n\n## contributing\n\nPull requests are welcome!\n\n\n\n[bundler]: http://bundler.io \"Manage your Ruby application's gem dependencies\"\n[ghpages]: https://pages.github.com/ \"GitHub Pages is a static site hosting service.\"\n[ghpages-gem]: https://github.com/github/pages-gem \"A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages\"\n[jekyll]: https://jekyllrb.com/ \"Jekyll is a blog-aware, static site generator in Ruby\"\n[loomscript]: https://github.com/LoomSDK/LoomSDK \"The Loom SDK, a native mobile app and game framework\"\n[loomtasks]: https://github.com/pixeldroid/loomtasks \"Rake tasks for working with loomlibs\"\n[lsdoc-api]: https://pixeldroid.github.io/lsdoc/ \"API docs for lsdoc\"\n[lsdoc-releases]: https://github.com/pixeldroid/lsdoc/releases \"releases for lsdoc\"\n[programming-pages]: https://github.com/pixeldroid/programming-pages \"a jekyll theme for publishing code documentation to GitHub pages\"\n[rake]: https://github.com/ruby/rake \"A make-like build utility for Ruby\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixeldroid%2Flsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixeldroid%2Flsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixeldroid%2Flsdoc/lists"}