{"id":18657902,"url":"https://github.com/lightsofapollo/insight","last_synced_at":"2026-01-25T02:32:07.039Z","repository":{"id":9885086,"uuid":"11888785","full_name":"lightsofapollo/insight","owner":"lightsofapollo","description":"Experimental documentation tool for web technologies.","archived":false,"fork":false,"pushed_at":"2013-08-05T03:23:57.000Z","size":108,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-18T01:07:04.481Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightsofapollo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-05T02:42:15.000Z","updated_at":"2014-05-15T23:29:57.000Z","dependencies_parsed_at":"2022-09-21T18:30:50.393Z","dependency_job_id":null,"html_url":"https://github.com/lightsofapollo/insight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lightsofapollo/insight","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Finsight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Finsight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Finsight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Finsight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightsofapollo","download_url":"https://codeload.github.com/lightsofapollo/insight/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightsofapollo%2Finsight/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28742510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T01:40:51.112Z","status":"online","status_checked_at":"2026-01-25T02:00:06.841Z","response_time":113,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-07T07:30:19.159Z","updated_at":"2026-01-25T02:32:07.023Z","avatar_url":"https://github.com/lightsofapollo.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# What is this?\n\nA documentation experiment. After many discussions on which\ndocumentation tool to use (yuidoc, jsdoc, jsduck, docco, etc..)\nI felt like it was time to experiment myself.\n\n### Great so what will this do...?\n\nDocumentation generation typically means generating a static website\nthat is served somewhere. I think its a flawed assumption that we should\ngenerate some static copy to describe our code that is _not_ actually\nthe code. Our code should live as a documented guide on _how_ to use the\ncode. Can we simply enhance how we view the code to create amazing\ndocumentation? [see docco's take on this]\n\nThe documentation viewer itself will be implemented using web standards\nand the [esprima](http://esprima.org/doc/) JavaScript parser. We will\nread files from disk and display formatted version of your code.\nBy using Markdown and code highlighting we can present a formatted\nversion of the code [similar to docco] with enhanced markdown document\nblocks. Additionally we can leverage the JS parser information to\npresent enhanced view of all function arguments and object properties.\n\n### Awesome where is the code!\n\nNothing yet- just ideas and a goal of having really nice documentation\nthat is really trivial to deploy/develop.\n\n### Won't this (if there was code) be really f'n slow?\n\nMaybe at first. I think with sane e-tag handling (http cache) and\ncaching the parsed results we will end up with something very fast.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2013 Sahaja James Lal\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%2Flightsofapollo%2Finsight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightsofapollo%2Finsight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightsofapollo%2Finsight/lists"}