Skip to content

Commit

Permalink
Add readme for GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
KnightMiner committed Oct 7, 2024
1 parent aa7eb3c commit 22d195b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
This repository contains the source code for the SlimeKnights Developer Documentation. Upon new commits, it will automatically update the site at https://slimeknights.github.io/.

This site is coded using [Jekyll](https://jekyllrb.com/) with the [minima v2.5](https://github.com/jekyll/minima/tree/2.5-stable) theme

## Contributing

If you wish to contribute to development of the SlimeKnights documentation, you can do a lot of it directly using the editor on GitHub. However, the best way would be to clone the repository locally, then install Jekyll to allow you to preview your changes on a local site before committing or making a pull request.

To do this, first follow the instructions to [install Jekyll and Bundler](https://jekyllrb.com/docs/installation/) on your system. Assuming you already have Ruby installed, this should be as simple as

```
gem install jekyll bundler
```

Once Jekyll and Bundler are installed, you can launch the website using
```
bundle exec jekyll serve
```
Which will make it available at http://localhost:4000.
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,6 @@ header_pages:
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/

exclude:
- README.md

0 comments on commit 22d195b

Please sign in to comment.