diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.dockerignore | 2 | ||||
| -rw-r--r-- | docs/Dockerfile | 17 | ||||
| -rw-r--r-- | docs/README.md | 36 | ||||
| -rw-r--r-- | docs/docker-compose.yml | 8 | ||||
| -rw-r--r-- | docs/download.md | 12 |
5 files changed, 66 insertions, 9 deletions
diff --git a/docs/.dockerignore b/docs/.dockerignore new file mode 100644 index 00000000..e494c5f2 --- /dev/null +++ b/docs/.dockerignore @@ -0,0 +1,2 @@ +_site +.jekyll-cache diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..226a4f2d --- /dev/null +++ b/docs/Dockerfile @@ -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
\ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..9b1d20d3 --- /dev/null +++ b/docs/README.md @@ -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.
\ No newline at end of file diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml new file mode 100644 index 00000000..70aed44d --- /dev/null +++ b/docs/docker-compose.yml @@ -0,0 +1,8 @@ +services: + jekyll: + build: + context: . + volumes: + - "./:/app" + ports: + - "4000:4000"
\ No newline at end of file diff --git a/docs/download.md b/docs/download.md index c7bad947..09158074 100644 --- a/docs/download.md +++ b/docs/download.md @@ -16,16 +16,10 @@ outdated versions. - [Modrinth](https://modrinth.com/mod/quests) - [GitHub](https://github.com/LMBishop/Quests/releases) - [Polymart](https://polymart.org/resource/quests.938) -- [Songoda](https://songoda.com/marketplace/product/quests-quests.544) +- [~~Songoda~~](https://songoda.com/marketplace/product/quests-quests.544) -Please note Hangar is still in active development and testing. It may be -removed at any time. - -### Distribution status - -Some platforms may not be up-to-date yet. - -<img src="https://mcbadges.leonardobishop.com/quests.svg"> +Some sources may be out of date. Please check the version number +before downloading. ## Development builds |