https://github.com/lkummer/satellite
Hugo theme for creating beautiful documentation websites.
https://github.com/lkummer/satellite
Last synced: 6 months ago
JSON representation
Hugo theme for creating beautiful documentation websites.
- Host: GitHub
- URL: https://github.com/lkummer/satellite
- Owner: LKummer
- License: gpl-3.0
- Created: 2021-06-21T13:36:19.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-29T22:17:56.000Z (about 3 years ago)
- Last Synced: 2025-03-12T20:22:22.328Z (over 1 year ago)
- Language: SCSS
- Homepage: https://lkummer.github.io/Satellite/
- Size: 3.58 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Satellite is a Hugo theme for creating beautiful documentation websites.
Check out the documentation.
Key Features •
Getting Started •
Contribution
## Key Features
- **Quickstart site** archive with ready to build website.
- **Thorough documentation and guides** for every feature of the theme.
- **Color customization** to make it yours.
- **Automatic dark mode** and manual toggle.
- **Fuzzy full-text search** with no dependency on external services.
- **Multi-version builds** to document your project over time.
- **Responsive design** for great user experience everywhere.
- **Search and sharing optimization** for Google, Facebook and Twitter.
## Getting Started
Make sure to have Hugo `v0.109.0` or later installed for best compatibility.
Download the latest `quickstart-site` archive [from the releases](https://github.com/LKummer/Satellite/releases).
Once extracted, you should have a ready to build website.
Run `hugo` to build the site, or `hugo server` to start a hot reload server.
[Check out the detailed tutorial](https://lkummer.github.io/Satellite/tutorial/part-1-getting-started/) for more information.
## Contribution
Please only contribute pull requests for open issues.
If an issue does not already exist, please open an issue.
It would be appreciated if you post a comment on an issue before submitting or working on a pull request for it.
Make sure to run `npm run format` and `npm run lint` before submitting commits to avoid failing CI pipelines.
### Development Workflow
**Note** these instructions are for development of Satellite itself.
For development of sites using the theme, [check out the documentation](https://lkummer.github.io/Satellite).
After cloning the project, install the required dependencies:
```s
$ npm ci
```
Quick summary of the development scripts:
- `build` - Build the Hugo theme, demo and documentation sites for production.
Linting the sources in the process. Built artifacts are placed in the `dist`
folder.
- `build:theme:debug` - Build the Hugo theme unminified with source maps.
- `dev` - Run the demo site development server.
- `dev:doc` - Run the documentation site development server.
- `lint` - Lint all files with ESLint, Stylelint and Prettier.
- `format` - Format all files with ESLint, Stylelint and Prettier.
The scripts can be invoked using `npm run`:
```s
$ npm run
```
For example, if we want to build the theme we can use the `build` script:
```s
$ npm run build
```
For more information [check out the detailed guide](https://lkummer.github.io/Satellite/contribution/development/).