https://github.com/solus-project/budgie-site
budgie-desktop.org
https://github.com/solus-project/budgie-site
Last synced: 9 months ago
JSON representation
budgie-desktop.org
- Host: GitHub
- URL: https://github.com/solus-project/budgie-site
- Owner: solus-project
- License: apache-2.0
- Created: 2016-12-24T13:45:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-11-24T15:06:45.000Z (over 7 years ago)
- Last Synced: 2025-01-02T11:11:56.949Z (over 1 year ago)
- Language: HTML
- Size: 3.33 MB
- Stars: 5
- Watchers: 5
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Budgie Site
Static, [Hugo-based](https://gohugo.io) home of Budgie Desktop. This website makes used of:
1. A custom theme, in `themes/budgie`.
2. Custom layouts and importable "fragments" for separation and modularizing of common components, within `layouts`.
3. Website content itself, including blog posts, in `content`.
**This does not include the LESS-based styling for the website. That is developed separately at the [budgie-site-styling repo](https://github.com/budgie-desktop/budgie-site-styling).**
## Creation
### New Post
To create a new post, call `hugo new PATH`. For instance, `hugo new blog/welcome-to-the-new-site.md` would create `welcome-to-the-new-site.md` with our default
configuration in the `content/blog/` directory.
## Development
### Setup
To get started on Budgie site development, run `make setup` on your Solus system. If you're not on Solus, you'll need to:
1. Install `hugo` 0.18.1 or above.
2. Run `git submodule init`.
Next, run `make sync` to sync the latest CSS and JS and ensure they are copied over the appropriate directories.
### Local Server
You can start up a local server by calling `make local` in the `budgie-site` directory. This will expose the site on `http://127.0.0.1:1313/home`.
**Note:** You should not need to restart the server when doing changes. Hugo does file watching across all the things.
### Deployment
To compile the website in preparation for deployment, run `make deploy`. This will create a `public-deployed` folder which can be uploaded to the server. Make sure you run a `make sync` prior to deployment,
to ensure you have the latest CSS and JS.
**Note:** This really only applies to the Budgie Desktop website administrators but since the Make recipe exists, may as well document it.
### Benchmarking
You can easily benchmark Hugo compilation by running `make benchmark`. You will get an output similar to:
```
Average time per operation: 170ms
Average memory allocated per operation: 114037kB
Average allocations per operation: 1299640
```
### Styling
I use 4-char wide tabs, not spaces, in everything **except** the YAML files. I know, I'm a monster.
## Licensing
- Budgie Site: Apache 2.0
- Information on Budgie Widget icon licensing can be found [here](https://github.com/budgie-desktop/budgie-desktop/tree/master/data/icons).
- Adapta GTK Theme logo licensed under [CC-By-SA 3.0](https://github.com/adapta-project/adapta-github-resources/blob/master/LICENSE.)
- The Arch Linux, Manjaro, and openSUSE distribution icons shipped in `imgs/distributions` of our theme's static directory are graciously provided by the [Paper Icon Theme](https://github.com/snwh/paper-icon-theme) and are licensed under [CC-By-SA 4.0](https://github.com/snwh/paper-icon-theme/blob/master/COPYING).
- The Ubuntu Budgie logo shipped in `imgs/distributions` of our theme's static directory is licensed under [CC-By-SA 4.0](https://github.com/UbuntuBudgie/assets/blob/master/LICENSE).