|
2 | 2 |
|
3 | 3 | Static, [Hugo-based](https://gohugo.io) home of Solus and its projects. This website makes use of: |
4 | 4 |
|
5 | | -1. A custom theme, [`solus-hugo-theme`](https://github.com/getsolus/solus-hugo-theme). |
6 | | -2. Website content itself, including blog posts, in `content`. |
| 5 | +1. A custom theme, [`solus-hugo-theme`](themes/solus). |
| 6 | +2. Website content itself, including blog posts, in [`content`](content). |
7 | 7 |
|
8 | | -**Note:** SASS styling is provided inside the Hugo themes and is built upon [`solbit`](https://github.com/getsolus/solbit). |
| 8 | +> [!Note] |
| 9 | +> SASS styling is provided inside the Hugo themes and is built upon [`solbit`](https://github.com/getsolus/solbit). |
9 | 10 |
|
10 | 11 | ## Creation |
11 | 12 |
|
@@ -75,19 +76,38 @@ For instance, Mailgun templates use the desktop collage graphic. Please coordina |
75 | 76 |
|
76 | 77 | ### Setup |
77 | 78 |
|
78 | | -To set up your Solus system for developing the website, you first need to ensure you have the necessary dependencies installed. Run `make setup` to install the necessary dependencies as well as init git submodules. |
| 79 | +To set up your Solus system for developing the website, you first need to ensure you have the necessary dependencies installed. You'll need: |
79 | 80 |
|
80 | | -Next, run `make sync` to update the Hugo themes. |
| 81 | +- `hugo` |
| 82 | +- `sassc` |
| 83 | +- Optionally, install `go-task` to simplify running the website locally, or deploying it to production. |
| 84 | + |
| 85 | +You can install these on Solus by running: |
| 86 | + |
| 87 | +```bash |
| 88 | +sudo eopkg install hugo sassc go-task |
| 89 | +``` |
81 | 90 |
|
82 | 91 | ### Local Server |
83 | 92 |
|
84 | | -You can start up a local server by calling `make local` in the `solus-site` directory. This will expose the site on `http://127.0.0.1:1313`. Use this to see your changes and make sure things look as you expect before submitting a pull request. |
| 93 | +You can start up a local server by running the task: |
| 94 | + |
| 95 | +```bash |
| 96 | +go-task local |
| 97 | +``` |
| 98 | + |
| 99 | +Use this to see your changes and make sure things look as you expect before submitting a pull request. |
85 | 100 |
|
86 | | -**Note:** You will not need to restart the server when doing changes. Hugo does file watching across all the things. |
| 101 | +> [!Note] |
| 102 | +> You will not need to restart the server when doing changes. Hugo does file watching across all the things. |
87 | 103 |
|
88 | 104 | ### Deployment |
89 | 105 |
|
90 | | -Merge the `main` branch into `deploy` and push. |
| 106 | +Run the task to deploy the website via Github Pages. |
| 107 | + |
| 108 | +```bash |
| 109 | +go-task deploy |
| 110 | +``` |
91 | 111 |
|
92 | 112 | ### Styling |
93 | 113 |
|
|
0 commit comments