-
-
Notifications
You must be signed in to change notification settings - Fork 19
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
1 changed file
with
20 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# EssentialsX Website | ||
|
||
The EssentialsX website hosted at https://essentialsx.net. | ||
|
||
This website is a static site generated using [Saber](https://saber.land/). The site uses the [Bulma](https://bulma.io) and [Buefy](https://buefy.org) frameworks. | ||
|
||
## Building | ||
|
||
### Set up your environment | ||
|
||
1. Ensure you have Git, Node.js and Yarn installed and on your path | ||
2. Clone the repository | ||
3. Run `git submodule update --init --recursive` | ||
4. Run `yarn install` | ||
|
||
### Commands | ||
|
||
- To start a development server with live reload: `yarn saber` | ||
- To build a site for deployment: `yarn saber build` | ||
- To update wiki content: `git submodule update --recursive --remote` |