-
Notifications
You must be signed in to change notification settings - Fork 1
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
30 changed files
with
15,459 additions
and
9 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,51 @@ | ||
name: Deploy to GitHub Pages | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
# Review gh actions docs if you want to further define triggers, paths, etc | ||
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on | ||
|
||
jobs: | ||
build: | ||
name: Build Docusaurus | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
cache: yarn | ||
|
||
- name: Install dependencies | ||
run: yarn install --frozen-lockfile | ||
- name: Build website | ||
run: yarn build | ||
|
||
- name: Upload Build Artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: build | ||
|
||
deploy: | ||
name: Deploy to GitHub Pages | ||
needs: build | ||
|
||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
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,26 @@ | ||
name: Test deployment | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
# Review gh actions docs if you want to further define triggers, paths, etc | ||
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on | ||
|
||
jobs: | ||
test-deploy: | ||
name: Test deployment | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
cache: yarn | ||
|
||
- name: Install dependencies | ||
run: yarn install --frozen-lockfile | ||
- name: Test build website | ||
run: yarn build |
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 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
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 |
---|---|---|
@@ -1,18 +1,41 @@ | ||
# Website | ||
|
||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
|
||
## Official Website | ||
### Installation | ||
|
||
- [Endurance Staking Launchpad](https://staking.fusionist.io/) | ||
``` | ||
$ yarn | ||
``` | ||
|
||
## Become a Validator | ||
### Local Development | ||
|
||
- [Server Preparation](https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-1-b27329fb0a9b) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-1-b27329fb0a9b) | ||
- [Node Setup and Staking](https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-2-173f62e3a9b7) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-2-173f62e3a9b7) | ||
- How to stake more validators [TODO] | ||
``` | ||
$ yarn start | ||
``` | ||
|
||
## Withdrawls | ||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
- [Withdrawal with Lighthouse command](https://medium.com/@fusionist.id/endurance-validator-withdrawal-process-d37163b2cd38) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/endurance-validator-withdrawal-process-d37163b2cd38) | ||
### Build | ||
|
||
- [Withdraw with ethdo](./withdraw_ethdo.md) | ||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
Using SSH: | ||
|
||
``` | ||
$ USE_SSH=true yarn deploy | ||
``` | ||
|
||
Not using SSH: | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> yarn deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
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,18 @@ | ||
|
||
|
||
## Official Website | ||
|
||
- [Endurance Staking Launchpad](https://staking.fusionist.io/) | ||
|
||
## Become a Validator | ||
|
||
- [Server Preparation](https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-1-b27329fb0a9b) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-1-b27329fb0a9b) | ||
- [Node Setup and Staking](https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-2-173f62e3a9b7) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/how-to-run-endurance-staking-node-2-173f62e3a9b7) | ||
- How to stake more validators [TODO] | ||
|
||
## Withdrawls | ||
|
||
- [Withdrawal with Lighthouse command](https://medium.com/@fusionist.id/endurance-validator-withdrawal-process-d37163b2cd38) (by @Syam) - [Archive](https://web.archive.org/web/20240513031109/https://medium.com/@fusionist.id/endurance-validator-withdrawal-process-d37163b2cd38) | ||
|
||
- [Withdraw with ethdo](./withdraw_ethdo.md) | ||
|
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,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
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,25 @@ | ||
--- | ||
slug: / | ||
sidebar_position: 1 | ||
--- | ||
|
||
# About Staking | ||
|
||
Endurance building based on Ethereum technology uses PoS mechanisms similar to Ethereum, allowing a validator to earn rewards in the network by staking 32 ACE. | ||
|
||
## Base Reward | ||
|
||
You can check the current APR data with this tool, which calculates rewards every day based on node real reward data: [ACE.STORE](https://beacon.fusionist.io/ethstore) | ||
|
||
You can also calculate your staking reward based on the current ACE price using this calculator: [Staking Calculator](https://beacon.fusionist.io/calculator) | ||
|
||
## Solo Staker Extra Reward | ||
|
||
For solo stakers who verify their execution address on the Discord channel, the Endurance Community will double your reward every month. For example, if the on-chain reward APR is 15%, you will get up to 30% after participating in the Staking Incentive Reward. | ||
|
||
Related Twitter post: https://x.com/fusionistio/status/1783492307083473370 | ||
|
||
Related announcement in Discord: https://discord.com/channels/926691694680870982/927073351292293130/1232955052377772133 | ||
|
||
|
||
|
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,8 @@ | ||
{ | ||
"label": "Tutorial - Basics", | ||
"position": 2, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "5 minutes to learn the most important Docusaurus concepts." | ||
} | ||
} |
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,23 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# Congratulations! | ||
|
||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. | ||
|
||
Docusaurus has **much more to offer**! | ||
|
||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. | ||
|
||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) | ||
|
||
## What's next? | ||
|
||
- Read the [official documentation](https://docusaurus.io/) | ||
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) | ||
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) | ||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) | ||
- Add a [search bar](https://docusaurus.io/docs/search) | ||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) | ||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) |
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,34 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Create a Blog Post | ||
|
||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... | ||
|
||
## Create your first Post | ||
|
||
Create a file at `blog/2021-02-28-greetings.md`: | ||
|
||
```md title="blog/2021-02-28-greetings.md" | ||
--- | ||
slug: greetings | ||
title: Greetings! | ||
authors: | ||
- name: Joel Marcey | ||
title: Co-creator of Docusaurus 1 | ||
url: https://github.com/JoelMarcey | ||
image_url: https://github.com/JoelMarcey.png | ||
- name: Sébastien Lorber | ||
title: Docusaurus maintainer | ||
url: https://sebastienlorber.com | ||
image_url: https://github.com/slorber.png | ||
tags: [greetings] | ||
--- | ||
|
||
Congratulations, you have made your first post! | ||
|
||
Feel free to play around and edit this post as much as you like. | ||
``` | ||
|
||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). |
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,57 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Create a Document | ||
|
||
Documents are **groups of pages** connected through: | ||
|
||
- a **sidebar** | ||
- **previous/next navigation** | ||
- **versioning** | ||
|
||
## Create your first Doc | ||
|
||
Create a Markdown file at `docs/hello.md`: | ||
|
||
```md title="docs/hello.md" | ||
# Hello | ||
|
||
This is my **first Docusaurus document**! | ||
``` | ||
|
||
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). | ||
|
||
## Configure the Sidebar | ||
|
||
Docusaurus automatically **creates a sidebar** from the `docs` folder. | ||
|
||
Add metadata to customize the sidebar label and position: | ||
|
||
```md title="docs/hello.md" {1-4} | ||
--- | ||
sidebar_label: 'Hi!' | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Hello | ||
|
||
This is my **first Docusaurus document**! | ||
``` | ||
|
||
It is also possible to create your sidebar explicitly in `sidebars.js`: | ||
|
||
```js title="sidebars.js" | ||
export default { | ||
tutorialSidebar: [ | ||
'intro', | ||
// highlight-next-line | ||
'hello', | ||
{ | ||
type: 'category', | ||
label: 'Tutorial', | ||
items: ['tutorial-basics/create-a-document'], | ||
}, | ||
], | ||
}; | ||
``` |
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,43 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Create a Page | ||
|
||
Add **Markdown or React** files to `src/pages` to create a **standalone page**: | ||
|
||
- `src/pages/index.js` → `localhost:3000/` | ||
- `src/pages/foo.md` → `localhost:3000/foo` | ||
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` | ||
|
||
## Create your first React Page | ||
|
||
Create a file at `src/pages/my-react-page.js`: | ||
|
||
```jsx title="src/pages/my-react-page.js" | ||
import React from 'react'; | ||
import Layout from '@theme/Layout'; | ||
|
||
export default function MyReactPage() { | ||
return ( | ||
<Layout> | ||
<h1>My React page</h1> | ||
<p>This is a React page</p> | ||
</Layout> | ||
); | ||
} | ||
``` | ||
|
||
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). | ||
|
||
## Create your first Markdown Page | ||
|
||
Create a file at `src/pages/my-markdown-page.md`: | ||
|
||
```mdx title="src/pages/my-markdown-page.md" | ||
# My Markdown page | ||
|
||
This is a Markdown page | ||
``` | ||
|
||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). |
Oops, something went wrong.