changing to docusaurus

spacemeshos · Jul 25, 2022 · 4aabf1e · 4aabf1e
1 parent 7148e4c
commit 4aabf1e
Show file tree

Hide file tree

Showing 204 changed files with 22,862 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -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*
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ 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.
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -0,0 +1,17 @@
+endi:
+  name: Endilie Yacop Sucipto
+  title: Maintainer of Docusaurus
+  url: https://github.com/endiliey
+  image_url: https://github.com/endiliey.png
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer @ Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
diff --git a/docs/ecosystem/dash_explore.md b/docs/ecosystem/dash_explore.md
@@ -0,0 +1,4 @@
+---
+id: dash
+title: Dashboard and Explorer
+---
diff --git a/docs/ecosystem/node.md b/docs/ecosystem/node.md
@@ -0,0 +1,4 @@
+---
+id: node
+title: Spacemesh Node
+---
diff --git a/docs/ecosystem/poet_server.md b/docs/ecosystem/poet_server.md
@@ -0,0 +1,4 @@
+---
+id: poet
+title: PoET Servers
+---
diff --git a/docs/ecosystem/smapp.md b/docs/ecosystem/smapp.md
@@ -0,0 +1,4 @@
+---
+id: smapp
+title: Smapp - the Spacemesh Application
+---
diff --git a/docs/learn/accounts.md b/docs/learn/accounts.md
@@ -0,0 +1,4 @@
+---
+id: accounts
+title: Accounts and Templates
+---
diff --git a/docs/learn/coin.md b/docs/learn/coin.md
@@ -0,0 +1,4 @@
+---
+id: coin
+title: Spacemesh Coin
+---
diff --git a/docs/learn/crypto.md b/docs/learn/crypto.md
@@ -0,0 +1,4 @@
+---
+id: crypto
+title: What Is Cryptocurrency?
+---
diff --git a/docs/learn/epochs.md b/docs/learn/epochs.md
@@ -0,0 +1,4 @@
+---
+id: epochs
+title: Storage and Epochs
+---
diff --git a/docs/learn/hare.md b/docs/learn/hare.md
@@ -0,0 +1,4 @@
+---
+id: hare
+title: Hare
+---
diff --git a/docs/learn/learn.md b/docs/learn/learn.md
@@ -0,0 +1,6 @@
+---
+id: learn
+title: Learn
+slug: /learn
+---
+ Test
diff --git a/docs/learn/nipost.md b/docs/learn/nipost.md
@@ -0,0 +1,4 @@
+---
+id: nipost
+title: NiPoST
+---
diff --git a/docs/learn/post.md b/docs/learn/post.md
@@ -0,0 +1,4 @@
+---
+id: post
+title: PoST (Proof of Space-time)
+---
diff --git a/docs/learn/rewards.md b/docs/learn/rewards.md
@@ -0,0 +1,4 @@
+---
+id: rewards
+title: Rewards
+---
diff --git a/docs/learn/spacemesh.md b/docs/learn/spacemesh.md
@@ -0,0 +1,4 @@
+---
+id: spacemesh
+title: What Is Spacemesh?
+---
diff --git a/docs/learn/tortoise.md b/docs/learn/tortoise.md
@@ -0,0 +1,4 @@
+---
+id: tortoise
+title: Tortoise
+---
diff --git a/docs/learn/transactions.md b/docs/learn/transactions.md
@@ -0,0 +1,4 @@
+---
+id: transactions
+title: Transactions
+---
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,25 @@
+---
+id: docs-overview
+title: Overview
+slug: /
+---
+
+Congratulations on deciding to use Eta! These docs will be your guide as you learn how to use this tool.
+
+:::tip
+
+These docs aren't 100% complete. If you just want to learn how to use Eta, go to [Learn](./docs/learn)
+
+:::
+
+## For people who learn by example
+
+We recommend going [here](./docs/learn) to find tutorials and lots of example code!
+
+## For API lovers
+
+Browse the API! You can view the TypeDoc API documentation for Eta at https://eta-dev.github.io/eta/modules/_index_.html.
+
+## Check out the source code
+
+Go to the [GitHub Repository](https://github.com/eta-dev/eta)
diff --git a/docs/protocol/consensus/activations.md b/docs/protocol/consensus/activations.md
@@ -0,0 +1,4 @@
+---
+id: activations
+title: Epochs and Activations
+---
diff --git a/docs/protocol/consensus/block_assembly.md b/docs/protocol/consensus/block_assembly.md
@@ -0,0 +1,4 @@
+---
+id: block-assembly
+title: Block Assembly
+---
diff --git a/docs/protocol/consensus/hare_abstract.md b/docs/protocol/consensus/hare_abstract.md
@@ -0,0 +1,4 @@
+---
+id: hare-abstract
+title: Abstract Hare
+---
diff --git a/docs/protocol/consensus/overview.md b/docs/protocol/consensus/overview.md
@@ -0,0 +1,4 @@
+---
+id: overview
+title: Protocol Overview
+---
diff --git a/docs/protocol/consensus/poet.md b/docs/protocol/consensus/poet.md
@@ -0,0 +1,4 @@
+---
+id: poet
+title: Proof of Elapsed Time
+---
diff --git a/docs/protocol/consensus/post_deep.md b/docs/protocol/consensus/post_deep.md
@@ -0,0 +1,4 @@
+---
+id: post-deep
+title: Proof of Space-Time
+---
diff --git a/docs/protocol/consensus/proposals.md b/docs/protocol/consensus/proposals.md
@@ -0,0 +1,4 @@
+---
+id: proposals
+title: Transactions, Proposals, and Blocks
+---
diff --git a/docs/protocol/consensus/protocol.md b/docs/protocol/consensus/protocol.md
@@ -0,0 +1,6 @@
+---
+id: protocol
+title: Deep Dive
+slug: /protocol
+---
+ Test
diff --git a/docs/protocol/consensus/random_beacon.md b/docs/protocol/consensus/random_beacon.md
@@ -0,0 +1,4 @@
+---
+id: random-beacon
+title: Random Beacon
+---
diff --git a/docs/protocol/consensus/rewards_algorithm.md b/docs/protocol/consensus/rewards_algorithm.md
@@ -0,0 +1,4 @@
+---
+id: rewards-algorithm
+title: Rewards Algorithm
+---
diff --git a/docs/protocol/consensus/tortoise_abstract.md b/docs/protocol/consensus/tortoise_abstract.md
@@ -0,0 +1,4 @@
+---
+id: tortoise-abstract
+title: Abstract Tortoise
+---
diff --git a/docs/protocol/consensus/weak_coin.md b/docs/protocol/consensus/weak_coin.md
@@ -0,0 +1,4 @@
+---
+id: weak-coin
+title: Weak Coin
+---
diff --git a/docs/protocol/node_operation/blacklisting.md b/docs/protocol/node_operation/blacklisting.md
@@ -0,0 +1,4 @@
+---
+id: blacklisting
+title: Blacklisting
+---
diff --git a/docs/protocol/node_operation/local_data_model.md b/docs/protocol/node_operation/local_data_model.md
@@ -0,0 +1,4 @@
+---
+id: local-data-model
+title: Local Data Model
+---
diff --git a/docs/protocol/node_operation/serialization.md b/docs/protocol/node_operation/serialization.md
@@ -0,0 +1,4 @@
+---
+id: serialization
+title: Serialization
+---
diff --git a/docs/protocol/node_operation/startup.md b/docs/protocol/node_operation/startup.md
@@ -0,0 +1,4 @@
+---
+id: startup
+title: Startup
+---
diff --git a/docs/protocol/node_operation/sync.md b/docs/protocol/node_operation/sync.md
@@ -0,0 +1,4 @@
+---
+id: sync
+title: Sync
+---
diff --git a/docs/protocol/node_operation/time.md b/docs/protocol/node_operation/time.md
@@ -0,0 +1,4 @@
+---
+id: time
+title: Time
+---
diff --git a/docs/protocol/smart_contracts/global_state.md b/docs/protocol/smart_contracts/global_state.md