{"id":18928847,"url":"https://github.com/lightninglabs/lightning-dev-site","last_synced_at":"2025-09-15T03:38:14.187Z","repository":{"id":23190619,"uuid":"95278960","full_name":"lightninglabs/lightning-dev-site","owner":"lightninglabs","description":"Lightning Network Daemon Developer Site","archived":false,"fork":false,"pushed_at":"2022-10-05T20:34:01.000Z","size":2133,"stargazers_count":25,"open_issues_count":24,"forks_count":40,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-28T22:34:41.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","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}},"created_at":"2017-06-24T06:01:54.000Z","updated_at":"2023-06-22T01:53:55.000Z","dependencies_parsed_at":"2023-01-13T22:54:38.826Z","dependency_job_id":null,"html_url":"https://github.com/lightninglabs/lightning-dev-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-dev-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-dev-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-dev-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-dev-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightninglabs","download_url":"https://codeload.github.com/lightninglabs/lightning-dev-site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249088793,"owners_count":21210863,"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:24.431Z","updated_at":"2025-04-15T14:31:41.794Z","avatar_url":"https://github.com/lightninglabs.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lightning Network Daemon Developer Site\nDeveloper guides and resources for the Lightning Network Daemon\n\n## Overview\n\nThis repository contains functionality for programmatically pulling guides from\nthe lnd repo, using a Python script and Jinja2 templates to output markdown\nfiles, which are the corresponding pages in the fully rendered Jekyll static\nsite. \n\nPay special attention to these files:\n- `templates/base.md`: The Jinja2 template fed into the Python\n  script, holding the Jeykll header to be prepended to the guide content pulled\n  from Github. The `templates` dir also holds the templates for special cases\n  where for example a dev site-specific footer needs to be appended\n- `update_and_render.sh`: Update local guides to the latest version available\n- `render.py`: The Python script that uses local guides and Jinja template to\n  strip out redundant titles, add page headers/footers, and output Jekyll\n  markdown\n- `deploy.sh`: Build static site from Jekyll markdown and deploy to Google Cloud\n  Platform\n\nThe rest of the files in this repo are the standard Jekyll site files.\n\n## Running the site locally\n\n### Prerequisites\n\nYou're going to need:\n\n - **Linux or OS X** — Windows may work, but is unsupported.\n - **Ruby, version 2.2.5 or newer**\n - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.\n\n### Running locally\n\n```shell\ngit clone https://github.com/lightninglabs/lightning-dev-site\n```\nInstall Jekyll:\n```\n$ gem install jekyll bundler\n```\nRun the site and watch for changes:\n```\n$ bundle exec jekyll serve\n```\n* If running remotely add: `--host=0.0.0.0`\n\n\n## Regenerating documentation\n\n```shell\n# Install Jinja for python templating\npip install Jinja2\n```\n\n### Get the latest INSTALL.md\n```shell\ncurl -o INSTALL.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/INSTALL.md\n```\n\n### Fetch the latest Docker guide\n```shell\ncurl -o DOCKER-README.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docker/README.md\n```\n\n### Get the latest gRPC guides\n```shell\ncurl -o python.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/python.md\ncurl -o javascript.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/javascript.md\n```\n\nLet's run the script to render the guides:\n```shell\npython render.py\n```\n\nNow that you're all set up, you can just run `./update_and_render.sh` to\nautomatically pull the latest markdown files and render the local Jekyll docs.\n\n## Deployment\n\nThe Lightning API is deployed with Google Cloud Platform. Visit [this blog\npost](https://little418.com/2015/07/jekyll-google-cloud-storage.html) for more\ninformation.\n\n### Steps\n\n1. Install Google Cloud SDK and authenticate into it:\n```bash\nbrew cask install google-cloud-sdk\ngcloud auth login\n```\n\n2. Build\n```bash\nbundle exec jekyll build\n```\n\n3. Push to Google Cloud Bucket\n```bash\n# -m use faster multithreaded uploads\n# -d delete remote files that aren't in the source\n# -r recurse into source subdirectories\ngsutil -m rsync -d -r ./_site gs://dev.lightning.community\n```\n\nIn the future, you can just run `./deploy.sh` to deploy automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-dev-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightninglabs%2Flightning-dev-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-dev-site/lists"}