-
-
Notifications
You must be signed in to change notification settings - Fork 310
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
9,706 additions
and
115 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
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 |
|---|---|---|
|
|
@@ -77,3 +77,7 @@ packages/cli/.git-data.json | |
| dictionary.dic | ||
|
|
||
| temp/ | ||
|
|
||
| # Docusaurus | ||
| .docusaurus | ||
| 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
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 @@ | ||
| # Website | ||
|
|
||
| This website is built using [Docusaurus](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. |
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,111 @@ | ||
| // @ts-check | ||
| // `@type` JSDoc annotations allow editor autocompletion and type checking | ||
| // (when paired with `@ts-check`). | ||
| // There are various equivalent ways to declare your Docusaurus config. | ||
| // See: https://docusaurus.io/docs/api/docusaurus-config | ||
|
|
||
| import {themes as prismThemes} from "prism-react-renderer"; | ||
|
|
||
| /** @type {import('@docusaurus/types').Config} */ | ||
| const config = { | ||
| title: "Lodestar", | ||
| tagline: "TypeScript Implementation of Ethereum Consensus", | ||
| favicon: "img/favicon.ico", | ||
|
|
||
| // Set the production url of your site here | ||
| url: "https://chainsafe.github.io/", | ||
| // Set the /<baseUrl>/ pathname under which your site is served | ||
| // For GitHub pages deployment, it is often '/<projectName>/' | ||
| baseUrl: "/lodestar/", | ||
|
|
||
| // GitHub pages deployment config. | ||
| organizationName: "ChainSafe", | ||
| projectName: "lodestar", | ||
|
|
||
| onBrokenLinks: "warn", | ||
| onBrokenMarkdownLinks: "warn", | ||
|
|
||
| i18n: { | ||
| defaultLocale: "en", | ||
| locales: ["en"], | ||
| }, | ||
|
|
||
| presets: [ | ||
| [ | ||
| "classic", | ||
| /** @type {import('@docusaurus/preset-classic').Options} */ | ||
| ({ | ||
| docs: { | ||
| path: "pages", | ||
| sidebarPath: "./sidebars.js", | ||
| editUrl: "https://github.com/ChainSafe/lodestar/tree/unstable/docs/", | ||
| routeBasePath: "/", | ||
| }, | ||
| theme: { | ||
| customCss: "./src/css/custom.css", | ||
| }, | ||
| }), | ||
| ], | ||
| ], | ||
|
|
||
| markdown: { | ||
| mermaid: true, | ||
| }, | ||
| themes: [ | ||
| '@docusaurus/theme-mermaid', | ||
| '@easyops-cn/docusaurus-search-local' | ||
| ], | ||
|
|
||
| themeConfig: | ||
| /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ | ||
| ({ | ||
| navbar: { | ||
| title: "Lodestar Documentation", | ||
| logo: { | ||
| alt: "Lodestar Logo", | ||
| src: "img/logo.png", | ||
| }, | ||
| items: [ | ||
| { | ||
| href: "https://github.com/ChainSafe/lodestar", | ||
| label: "GitHub", | ||
| position: "right", | ||
| }, | ||
| ], | ||
| }, | ||
| footer: { | ||
| style: "dark", | ||
| links: [ | ||
| { | ||
| title: "Docs", | ||
| items: [ | ||
| { | ||
| label: "Introduction", | ||
| to: "/introduction", | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: "Community", | ||
| items: [ | ||
| { | ||
| label: "Discord", | ||
| href: "https://discord.com/invite/yjyvFRP", | ||
| }, | ||
| { | ||
| label: "Twitter", | ||
| href: "https://twitter.com/lodestar_eth", | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| copyright: `Copyright © ${new Date().getFullYear()} ChainSafe, Inc.`, | ||
| }, | ||
| prism: { | ||
| theme: prismThemes.github, | ||
| darkTheme: prismThemes.dracula, | ||
| }, | ||
| }), | ||
| }; | ||
|
|
||
| export default config; |
Binary file not shown.
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,46 @@ | ||
| { | ||
| "name": "@lodestar/docs", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "docusaurus": "docusaurus", | ||
| "start": "docusaurus start", | ||
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "clear": "docusaurus clear", | ||
| "serve": "docusaurus serve", | ||
| "write-translations": "docusaurus write-translations", | ||
| "write-heading-ids": "docusaurus write-heading-ids" | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "3.1.1", | ||
| "@docusaurus/preset-classic": "3.1.1", | ||
| "@docusaurus/theme-mermaid": "^3.1.1", | ||
| "@easyops-cn/docusaurus-search-local": "^0.40.1", | ||
| "@mdx-js/react": "^3.0.0", | ||
| "clsx": "^2.0.0", | ||
| "prism-react-renderer": "^2.3.0", | ||
| "react": "^18.0.0", | ||
| "react-dom": "^18.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@docusaurus/module-type-aliases": "3.1.1", | ||
| "@docusaurus/types": "3.1.1" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.5%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 3 chrome version", | ||
| "last 3 firefox version", | ||
| "last 5 safari version" | ||
| ] | ||
| }, | ||
| "engines": { | ||
| "node": ">=18.0" | ||
| } | ||
| } |
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
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
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
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
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
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
Oops, something went wrong.