{"id":18928839,"url":"https://github.com/lightninglabs/lightning-api-ng","last_synced_at":"2025-07-01T03:05:12.146Z","repository":{"id":85593044,"uuid":"517734449","full_name":"lightninglabs/lightning-api-ng","owner":"lightninglabs","description":"Automated API-documentation generation source code for Lightning Lab's FOSS software suite","archived":false,"fork":false,"pushed_at":"2025-05-17T03:11:11.000Z","size":501,"stargazers_count":6,"open_issues_count":9,"forks_count":8,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-07-01T03:03:59.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/lightninglabs.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}},"created_at":"2022-07-25T16:09:45.000Z","updated_at":"2025-05-17T03:11:05.000Z","dependencies_parsed_at":"2025-01-06T19:27:31.556Z","dependency_job_id":"3bedd9b9-0d41-4d87-a0ba-b7f01f228637","html_url":"https://github.com/lightninglabs/lightning-api-ng","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lightninglabs/lightning-api-ng","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-api-ng","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-api-ng/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-api-ng/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-api-ng/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightninglabs","download_url":"https://codeload.github.com/lightninglabs/lightning-api-ng/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-api-ng/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262887159,"owners_count":23379766,"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-11-08T11:28:14.907Z","updated_at":"2025-07-01T03:05:12.077Z","avatar_url":"https://github.com/lightninglabs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lightning API Docs\n\nThis repo contains the source code used to generate the API docs websites for LND,\nLoop, Pool, Faraday, and Taproot Assets Protocol: https://lightning.engineering/api-docs/\n\n## Architecture\n\nThe websites are automatically generated from the protobuf definition files\n(`*.proto`) and Swagger/OpenAPI files (`*.swagger.json`) found in the Github\nrepositories of each application. These files are sourced from the following\nrepos:\n\n- LND: https://github.com/lightningnetwork/lnd\n- Loop: https://github.com/lightninglabs/loop\n- Pool: https://github.com/lightninglabs/pool\n- Faraday: https://github.com/lightninglabs/faraday\n- Taproot Assets Protocol: https://github.com/lightninglabs/taproot-assets\n- Lightning Terminal (LiT): https://github.com/lightninglabs/lightning-terminal\n\nThere is a multi-stage pipeline to consume the protobuf \u0026 Swagger files and\nconvert them into an HTML static website. The process is as follows:\n\n```\n+ ./generate.sh\n  |\n  | - downloads the master branch of each repo\n  | - uses protoc to convert *.proto to generated.json\n  | - compiles `cmd/mdgen/main.go` into ./mdgen console app\n  |\n+ ./mdgen\n  |\n  | - outputs markdown files into site/docs/\n  |\n+ yarn build\n  |\n  | - builds the Docusaurus site\n  | - converts the markdown pages into HTML\n  |\n+ Output Static Website\n```\n\nThis process is run every day at midnight UTC by a cron job. After the build,\nthe static sites are deployed.\n\n## Development\n\nFollow these steps to run the pipeline locally. You can modify the source\ncode for the `mdgen` tool and the markdown templates (in `templates/`), to\nalter the generated static pages.\n\n**System Requirements**\n\n- [Go](https://golang.org) v1.18+\n- [protoc](https://github.com/protocolbuffers/protobuf/releases/tag/v3.6.0) v3.6.0 (newer versions may not work as expected)\n- [NodeJS](https://nodejs.org) v16.x or v18.x\n\n#### Initial Setup\n\n1. Clone this repo\n   ```bash\n   $ git clone https://github.com/lightninglabs/lightning-api-ng.git\n   $ cd lightning-api-ng\n   ```\n1. Install NodeJS dependencies\n   ```bash\n   $ cd site/\n   $ yarn\n   ```\n\n#### Active development\n\n1. Run the script to generate JSON files for each daemon from their proto files\n   ```bash\n   $ ./generate.sh\n   ```\n1. In one terminal, start the script to watch for changes of source\n   files and automatically regenerate the markdown files\n   ```bash\n   $ ./watch.sh\n   ```\n1. In a second terminal, start the Docusaurus site\n   ```bash\n   $ cd site/\n   $ yarn start\n   ```\n1. A new browser window should automatically open http://localhost:3000/api-docs/\n\n#### Building the static website for deployment\n\n1. Run the script to generate JSON files for each daemon from their proto files\n   ```bash\n   $ ./generate.sh\n   ```\n1. Build the static site\n   ```bash\n   $ cd site/\n   $ yarn build\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-api-ng","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightninglabs%2Flightning-api-ng","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-api-ng/lists"}