https://github.com/gonx/dustforce-wiki
A statically generated informational site for the 2D platformer Dustforce
https://github.com/gonx/dustforce-wiki
dustforce jekyll-site no-javascript sass
Last synced: about 1 month ago
JSON representation
A statically generated informational site for the 2D platformer Dustforce
- Host: GitHub
- URL: https://github.com/gonx/dustforce-wiki
- Owner: gonX
- License: lgpl-2.1
- Created: 2019-06-06T08:57:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T06:00:51.000Z (about 3 years ago)
- Last Synced: 2025-03-21T15:09:34.034Z (about 1 year ago)
- Topics: dustforce, jekyll-site, no-javascript, sass
- Language: Python
- Homepage: https://www.dustforce.info/
- Size: 3.96 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to the dustforce-wiki!
For contributing, please see [CONTRIBUTING.md](/CONTRIBUTING.md).
For a somewhat up to date representation view of the compiled repo, see [dustforce.info](https://www.dustforce.info/)
# Building the site locally
## Prerequisites
- Ruby (tested with 3.0.3)
- [bundler](https://bundler.io/) (tested with 2.2.26)
Bundler is technically not necessary if you can manage the Ruby dependencies (such as Jekyll) by yourself, but it is easier to get started by using Bundler.
#### Rubygem users
If you have a working [rubygems](https://rubygems.org/) (`gem`) install, you should be able to simply `gem install bundler` to cover the prerequisites.
## Building
On your very first run:
```
$ cd website/
$ bundle install
```
then on any following runs, you can simply do:
```
$ cd website/
$ bundle exec jekyll build
```
## Serving site from Jekyll
To run a local development server, you can simply run:
```
$ cd website/
$ bundle exec jekyll serve --incremental
```
This will also build the site for you, and present it to you at `http://127.0.0.1:4000` while keeping the site updated as content changes.
Some files are not or can not be monitored by the serve process (such as `website/_config.yml`), requiring you to restart the serve process.