Skip to content
Documentation for Sponge and its Implementations
Branch: stable
Clone or download
Grauldon and Inscrutable Updates for new Versioning Policy (#785)
* Updated Java version shipped with Mojang Installer inside of note

* Updated SpongeDocs for new versioning policy

* Updated per comments in PR

* Reverted version per comments in PR

* Made updates and corrections to filename docs per comments in PR

* Missed two corrections of version in filename

* Rewrote versioning.rst and corrected/improved filenames.rst

* Added warning removed by error, toned down another warning, and corrected RC section

* Reworded release candidate section

* Converted relative path to absolute path

Signed-off-by: Grauldon <17791090+Grauldon@users.noreply.github.com>

* Added required changes missed during earlier review

Signed-off-by: Grauldon <17791090+Grauldon@users.noreply.github.com>

* Converted relative paths to absolute paths

Signed-off-by: Grauldon <17791090+Grauldon@users.noreply.github.com>

* Corrected examples to use accurate filenames

Signed-off-by: Grauldon <17791090+Grauldon@users.noreply.github.com>

* Reorder the sidebar and add parenthetical note for SemVer

Signed-off-by: Grauldon <17791090+Grauldon@users.noreply.github.com>
Latest commit 594db29 Mar 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
tools
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md Make CONTRIBUTING.md Nov 5, 2017
LICENSE.txt
README.md Docs clarification and rewrite some code samples #691 (#773) Nov 21, 2018
crowdin.yaml
gulpfile.js Update Gulp to 4.0.0, add package-lock.json (#715) Jul 28, 2018
package-lock.json
package.json Update Gulp to 4.0.0, add package-lock.json (#715) Jul 28, 2018
requirements.txt Update Sphinx and sponge-docs-theme, add CC-BY-SA footer Nov 5, 2017

README.md

Sponge Documentation Build Status

This is the repository where the Sponge documentation is held.

The latest version may be viewed in full by visiting Sponge Docs

Contributing

Instructions and Guidelines on how to contribute can be found on the Docs themselves.

Licensing

The Sponge Documentation is licensed under the Creative Commons - Share-Alike license.

You can read more about our licensing situation on the documentation itself.

Translations

We're eagerly looking for translators! Please visit the CrowdIn translation page, sign up, join the team, and start translating.

Local Environment

You can setup an environment so you can instantly see the changes that have been made to the docs.

  1. Install Python 3
  2. Install node.js

In terminal or the command line, within the directory containing this README, run the following commands:

npm install -g gulp
npm install
pip install -r requirements.txt
gulp

Your browser should open to reveal the docs. When you make a change to the documentation, the docs should refresh in the browser (possibly after a few seconds).

You can’t perform that action at this time.