-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aa7eb3c
commit 22d195b
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -65,3 +65,6 @@ header_pages: | |
# - vendor/cache/ | ||
# - vendor/gems/ | ||
# - vendor/ruby/ | ||
|
||
exclude: | ||
- README.md |