|
1 | | -# goldendog |
2 | | - |
3 | | -Welcome to the GoldenDog Linux Jekyll Layout. |
4 | | -This is a layout I built for the [GoldenDog Linux Official Homepage](https://www.goldendoglinux.org) |
5 | | - |
6 | | -If you find it useful and would like to deploy this layout on your github pages account, the easiest thing to do would be to just fork this project and do all the changes that you like. |
7 | | - |
8 | | -This layout is MIT licensed. You don't even need to credit myself (Alexia) or GoldenDog, but it is always nice if you do :3 |
9 | | - |
10 | | -Also, It would make me really happy to know if you are running this somewhere. It's the first time I try to build a complete Jekyll Theme. |
| 1 | +# Website |
11 | 2 |
|
| 3 | +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. |
12 | 4 |
|
13 | 5 | ## Installation |
14 | 6 |
|
15 | | -Add this line to your Jekyll site's `Gemfile`: |
16 | | - |
17 | | -```ruby |
18 | | -gem "goldendog" |
| 7 | +```bash |
| 8 | +yarn |
19 | 9 | ``` |
20 | 10 |
|
21 | | -And add this line to your Jekyll site's `_config.yml`: |
| 11 | +## Local Development |
22 | 12 |
|
23 | | -```yaml |
24 | | -theme: goldendog |
| 13 | +```bash |
| 14 | +yarn start |
25 | 15 | ``` |
26 | 16 |
|
27 | | -And then execute: |
28 | | -
|
29 | | - $ bundle |
| 17 | +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
30 | 18 |
|
31 | | -Or install it yourself as: |
| 19 | +## Build |
32 | 20 |
|
33 | | - $ gem install goldendog |
34 | | -
|
35 | | -## Usage |
36 | | -
|
37 | | -TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets. |
38 | | -
|
39 | | -## Contributing |
| 21 | +```bash |
| 22 | +yarn build |
| 23 | +``` |
40 | 24 |
|
41 | | -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/goldendog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct. |
| 25 | +This command generates static content into the `build` directory and can be served using any static contents hosting service. |
42 | 26 |
|
43 | | -## Development |
| 27 | +## Deployment |
44 | 28 |
|
45 | | -To set up your environment to develop this theme, run `bundle install`. |
| 29 | +Using SSH: |
46 | 30 |
|
47 | | -Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. |
| 31 | +```bash |
| 32 | +USE_SSH=true yarn deploy |
| 33 | +``` |
48 | 34 |
|
49 | | -When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled. |
50 | | -To add a custom directory to your theme-gem, please edit the regexp in `goldendog.gemspec` accordingly. |
| 35 | +Not using SSH: |
51 | 36 |
|
52 | | -## License |
| 37 | +```bash |
| 38 | +GIT_USER=<Your GitHub username> yarn deploy |
| 39 | +``` |
53 | 40 |
|
54 | | -The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |
| 41 | +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
0 commit comments