{"id":20900372,"url":"https://github.com/lkummer/satellite","last_synced_at":"2025-12-24T20:42:29.640Z","repository":{"id":132675259,"uuid":"378942371","full_name":"LKummer/Satellite","owner":"LKummer","description":"Hugo theme for creating beautiful documentation websites.","archived":false,"fork":false,"pushed_at":"2023-05-29T22:17:56.000Z","size":3754,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-12T20:22:22.328Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://lkummer.github.io/Satellite/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LKummer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-06-21T13:36:19.000Z","updated_at":"2024-10-23T06:37:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"85065858-2189-44fa-a941-59776a020076","html_url":"https://github.com/LKummer/Satellite","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/LKummer/Satellite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LKummer%2FSatellite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LKummer%2FSatellite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LKummer%2FSatellite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LKummer%2FSatellite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LKummer","download_url":"https://codeload.github.com/LKummer/Satellite/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LKummer%2FSatellite/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28008433,"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","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"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-18T11:19:13.537Z","updated_at":"2025-12-24T20:42:29.612Z","avatar_url":"https://github.com/LKummer.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://lkummer.github.io/Satellite/\"\u003e\n    \u003cimg width=\"55%\" src=\"https://lkummer.github.io/Satellite/images/readme-logo.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/LKummer/Satellite/releases\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/tag/LKummer/Satellite?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/LKummer/Satellite/actions/workflows/integration.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/LKummer/Satellite/integration.yml?label=integration\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/LKummer/Satellite/actions/workflows/delivery.yml\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/LKummer/Satellite/delivery.yml?label=delivery\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/LKummer/Satellite/blob/master/LICENSE.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/LKummer/Satellite?style=flat-square\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Satellite is a Hugo theme for creating beautiful documentation websites.\n  \u003ca href=\"https://lkummer.github.io/Satellite/\"\u003e\n    Check out the documentation.\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#key-features\"\u003eKey Features\u003c/a\u003e •\n  \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e •\n  \u003ca href=\"#contribution\"\u003eContribution\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://lkummer.github.io/Satellite/\"\u003e\n    \u003cimg src=\"https://lkummer.github.io/Satellite/images/readme-banner.svg\" align=\"center\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Key Features\n\n- **Quickstart site** archive with ready to build website.\n- **Thorough documentation and guides** for every feature of the theme.\n- **Color customization** to make it yours.\n- **Automatic dark mode** and manual toggle.\n- **Fuzzy full-text search** with no dependency on external services.\n- **Multi-version builds** to document your project over time.\n- **Responsive design** for great user experience everywhere.\n- **Search and sharing optimization** for Google, Facebook and Twitter.\n\n\u003cp\u003e\n  \u003ca href=\"https://lkummer.github.io/Satellite/\"\u003e\n    \u003cimg src=\"https://lkummer.github.io/Satellite/images/readme-theme.svg\" align=\"center\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Getting Started\n\nMake sure to have Hugo `v0.109.0` or later installed for best compatibility.\n\nDownload the latest `quickstart-site` archive [from the releases](https://github.com/LKummer/Satellite/releases).\nOnce extracted, you should have a ready to build website.\nRun `hugo` to build the site, or `hugo server` to start a hot reload server.\n\n[Check out the detailed tutorial](https://lkummer.github.io/Satellite/tutorial/part-1-getting-started/) for more information.\n\n## Contribution\n\nPlease only contribute pull requests for open issues.\nIf an issue does not already exist, please open an issue.\n\nIt would be appreciated if you post a comment on an issue before submitting or working on a pull request for it.\n\nMake sure to run `npm run format` and `npm run lint` before submitting commits to avoid failing CI pipelines.\n\n### Development Workflow\n\n**Note** these instructions are for development of Satellite itself.\nFor development of sites using the theme, [check out the documentation](https://lkummer.github.io/Satellite).\n\nAfter cloning the project, install the required dependencies:\n\n```s\n$ npm ci\n```\n\nQuick summary of the development scripts:\n\n- `build` - Build the Hugo theme, demo and documentation sites for production.\n  Linting the sources in the process. Built artifacts are placed in the `dist`\n  folder.\n- `build:theme:debug` - Build the Hugo theme unminified with source maps.\n- `dev` - Run the demo site development server.\n- `dev:doc` - Run the documentation site development server.\n- `lint` - Lint all files with ESLint, Stylelint and Prettier.\n- `format` - Format all files with ESLint, Stylelint and Prettier.\n\nThe scripts can be invoked using `npm run`:\n\n```s\n$ npm run \u003cscript\u003e\n```\n\nFor example, if we want to build the theme we can use the `build` script:\n\n```s\n$ npm run build\n```\n\nFor more information [check out the detailed guide](https://lkummer.github.io/Satellite/contribution/development/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkummer%2Fsatellite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flkummer%2Fsatellite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkummer%2Fsatellite/lists"}