Skip to content

Commit

Permalink
Remove expired links from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LMBishop committed Sep 30, 2023
1 parent ba56278 commit 9206827
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 12 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
<img src="https://img.shields.io/github/actions/workflow/status/LMBishop/Quests/build.yml?branch=master">
<img src="https://img.shields.io/github/issues-raw/LMBishop/Quests">
<img src="https://img.shields.io/spiget/version/23696?color=inactive&label=version">
<img src="https://mcbadges.leonardobishop.com/all/downloads?spigot=23696&songoda=quests-quests&polymart=938">

[//]: # (<img src="https://mcbadges.leonardobishop.com/all/downloads?spigot=23696&songoda=quests-quests&polymart=938">)
<br>
<h1 align="center">Quests</h1>
</p>
Expand All @@ -20,8 +21,6 @@
The latest release version of Quests can be found [here](https://quests.leonardobishop.com/download.html).
The latest build of Quests (development version) can be found on [GitHub](https://github.com/LMBishop/Quests/actions).

<img src="https://mcbadges.leonardobishop.com/quests.svg"/>

Alternatively, you can build Quests via Gradle. Release versions of Quests are built using **Gradle**, targeting **Java 17**. You can change the target version in ``build.gradle``.
* Ensure Java is installed on your machine
* Clone this repository
Expand Down
2 changes: 2 additions & 0 deletions docs/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_site
.jekyll-cache
17 changes: 17 additions & 0 deletions docs/Dockerfile
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
36 changes: 36 additions & 0 deletions docs/README.md
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.
8 changes: 8 additions & 0 deletions docs/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
services:
jekyll:
build:
context: .
volumes:
- "./:/app"
ports:
- "4000:4000"
12 changes: 3 additions & 9 deletions docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 9206827

Please sign in to comment.