-
-
Notifications
You must be signed in to change notification settings - Fork 85
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
Showing
6 changed files
with
68 additions
and
12 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
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,2 @@ | ||
_site | ||
.jekyll-cache |
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,17 @@ | ||
FROM ruby:3.2.2 | ||
|
||
RUN bundle config --global frozen 1 && \ | ||
mkdir -p /vendor/bundle && \ | ||
bundle config set --local path /vendor/bundle | ||
|
||
WORKDIR /app | ||
|
||
COPY Gemfile Gemfile.lock ./ | ||
|
||
RUN bundle install | ||
|
||
COPY . . | ||
|
||
EXPOSE 4000 | ||
|
||
CMD bundle exec jekyll serve --host 0.0.0.0 --port 4000 --destination /tmp/_site |
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,36 @@ | ||
# Quests documentation | ||
|
||
This directory contains the documentation for Quests. You can | ||
build it using Jekyll, or view it online at | ||
[https://quests.leonardobishop.com/](https://quests.leonardobishop.com/). | ||
|
||
## Building | ||
|
||
To build the documentation, you will need to install Jekyll. You can | ||
do this by following the instructions on the | ||
[Jekyll website](https://jekyllrb.com/docs/installation/). | ||
|
||
Once you have Jekyll installed, you can build the documentation by | ||
running `jekyll build` in this directory. The documentation will be | ||
built into the `_site` directory. | ||
|
||
``` | ||
bundle exec jekyll build | ||
``` | ||
|
||
Alternatively, you may use the pre-defined docker-compose.yml file to | ||
build and serve the documentation. | ||
|
||
``` | ||
docker compose up --build | ||
``` | ||
|
||
## Contributing | ||
|
||
See [contributing-to-the-wiki.md](contributing-to-the-wiki.md). | ||
(Online version: | ||
[https://quests.leonardobishop.com/contributing-to-the-wiki.html](https://quests.leonardobishop.com/contributing-to-the-wiki.html) | ||
|
||
## License | ||
|
||
This documentation is subject to the same license as Quests itself. |
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,8 @@ | ||
services: | ||
jekyll: | ||
build: | ||
context: . | ||
volumes: | ||
- "./:/app" | ||
ports: | ||
- "4000: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