{"id":48187764,"url":"https://github.com/elk-audio/elk-docs","last_synced_at":"2026-04-04T17:51:54.488Z","repository":{"id":103769540,"uuid":"219701425","full_name":"elk-audio/elk-docs","owner":"elk-audio","description":"User documentation for Elk Audio OS","archived":false,"fork":false,"pushed_at":"2026-03-30T09:32:35.000Z","size":59320,"stargazers_count":44,"open_issues_count":5,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2026-03-30T11:31:26.158Z","etag":null,"topics":["audio","elk","elk-audio","linux","low-latency","vst"],"latest_commit_sha":null,"homepage":"https://elk-audio.github.io/elk-docs/html/index.html","language":"Python","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/elk-audio.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-05T09:04:07.000Z","updated_at":"2026-03-30T09:21:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"8248ed4a-6be4-460b-b088-e34484272a29","html_url":"https://github.com/elk-audio/elk-docs","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/elk-audio/elk-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elk-audio%2Felk-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elk-audio%2Felk-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elk-audio%2Felk-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elk-audio%2Felk-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elk-audio","download_url":"https://codeload.github.com/elk-audio/elk-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elk-audio%2Felk-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31407655,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["audio","elk","elk-audio","linux","low-latency","vst"],"created_at":"2026-04-04T17:51:54.009Z","updated_at":"2026-04-04T17:51:54.473Z","avatar_url":"https://github.com/elk-audio.png","language":"Python","readme":"# Elk Development Kit Documentation\n\nTo read the documentation, follow this link: https://elk-audio.github.io/elk-docs/\n\nThis repository contains the source files, and generated HTML output, for the Elk Development Kit Documentation.\n\nIf you have cloned/downloaded this repository you can browse the documentation by opening the `./docs/index.html` file in your browser.\n\nMost sections are written in MarkDown, and have to use the [CommonMark flavor](https://commonmark.org/), the accepted standard by [Sphinx](http://www.sphinx-doc.org) and [ReadtheDocs](https://readthedocs.com/). Some exceptions, such as is the index, use ReStructuredText - the main format for Sphinx.\n\n## Building HTML From Source Files\n\nIf you have made any changes to an .MD documentation file, you also need to take the below steps to make the changes available through the web link.\n\nInstall [Sphinx](http://www.sphinx-doc.org/en/stable/):\n\n\tpip install -r requirements.txt\n\nAlternatively, via apt (discouraged)\n\n\tapt-get install python3-sphinx\n\nBuild with:\n\n\tmake html\n\nAlternatively, if you've pip-installed Sphinx:w\n\n\tpython3 -m sphinx -M html ./ ./docs/\n\nThe output will be generated in `docs`, the folder expected by GitHub Pages for the HTML files it serves. \n\nDo commit and push both your changed .MD, and generated HTML files, for your changes to be reflected on the online HTML version of the documentation.\n\nIn the  `docs` folder, there are two files added manually, needed for GitHub Pages: `.nojekyll`, and `index.html`. If you every type `make clean`, these two will be deleted - ensure you then reinstate them before committing.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felk-audio%2Felk-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felk-audio%2Felk-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felk-audio%2Felk-docs/lists"}