Skip to content

Commit 73f91ff

Browse files
authored
Merge pull request #1 from open-rpc/feat/docusaurus
Feat/docusaurus
2 parents f910189 + 04e4771 commit 73f91ff

File tree

81 files changed

+48736
-9698
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+48736
-9698
lines changed

.github/workflows/deploy.yaml

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,45 @@ on:
66
- main
77
workflow_dispatch:
88

9-
env:
10-
GITHUB_REPOSITORY: ${{ github.repository }}
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
1113

12-
jobs:
13-
deploy-gh-pages:
14-
permissions:
15-
pages: write
16-
id-token: write
17-
contents: write
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
1817

18+
jobs:
19+
build:
1920
runs-on: ubuntu-latest
2021
steps:
2122
- uses: actions/checkout@v4
23+
2224
- name: Use Node.js 22
2325
uses: actions/setup-node@v4
2426
with:
25-
node-version: '22'
26-
- run: npm ci
27-
- run: npm run build:spec
28-
- run: npm run build:docs
29-
- name: Deploy to GitHub Pages
30-
uses: peaceiris/actions-gh-pages@v4
27+
node-version: "22"
28+
cache: npm
29+
30+
- name: Install dependencies
31+
run: npm ci
32+
33+
- name: Build docs
34+
run: npm run build:docs
35+
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
3138
with:
32-
github_token: ${{ secrets.GITHUB_TOKEN }}
33-
publish_dir: build/docs/gatsby/public
34-
commit_message: "Deploy to GitHub Pages"
39+
path: build
40+
41+
deploy:
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
runs-on: ubuntu-latest
46+
needs: build
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ data.json
77
schema.json
88
*.dic
99
.idea/
10+
.docusaurus/
11+
.DS_Store

docs-api/api/index.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
# GENERATED DOCUMENTATION - DO NOT EDIT THIS FILE
3+
title: "Ethereum JSON-RPC Specification"
4+
description: "A specification of the standard interface for Ethereum clients."
5+
sidebar_label: "Ethereum JSON-RPC Specification"
6+
tags:
7+
- json-rpc
8+
- openrpc
9+
---
10+
11+
# Ethereum JSON-RPC Specification
12+
13+
Version: `0.0.0`
14+
15+
A specification of the standard interface for Ethereum clients.
16+
17+
18+
## Methods
19+
20+
- [`debug_getBadBlocks`](./methods/debug_getBadBlocks.mdx)
21+
- [`debug_getRawBlock`](./methods/debug_getRawBlock.mdx)
22+
- [`debug_getRawHeader`](./methods/debug_getRawHeader.mdx)
23+
- [`debug_getRawReceipts`](./methods/debug_getRawReceipts.mdx)
24+
- [`debug_getRawTransaction`](./methods/debug_getRawTransaction.mdx)
25+
- [`engine_exchangeCapabilities`](./methods/engine_exchangeCapabilities.mdx)
26+
- [`engine_exchangeTransitionConfigurationV1`](./methods/engine_exchangeTransitionConfigurationV1.mdx)
27+
- [`engine_forkchoiceUpdatedV1`](./methods/engine_forkchoiceUpdatedV1.mdx)
28+
- [`engine_forkchoiceUpdatedV2`](./methods/engine_forkchoiceUpdatedV2.mdx)
29+
- [`engine_forkchoiceUpdatedV3`](./methods/engine_forkchoiceUpdatedV3.mdx)
30+
- [`engine_getBlobsV1`](./methods/engine_getBlobsV1.mdx)
31+
- [`engine_getBlobsV2`](./methods/engine_getBlobsV2.mdx)
32+
- [`engine_getPayloadBodiesByHashV1`](./methods/engine_getPayloadBodiesByHashV1.mdx)
33+
- [`engine_getPayloadBodiesByRangeV1`](./methods/engine_getPayloadBodiesByRangeV1.mdx)
34+
- [`engine_getPayloadV1`](./methods/engine_getPayloadV1.mdx)
35+
- [`engine_getPayloadV2`](./methods/engine_getPayloadV2.mdx)
36+
- [`engine_getPayloadV3`](./methods/engine_getPayloadV3.mdx)
37+
- [`engine_getPayloadV4`](./methods/engine_getPayloadV4.mdx)
38+
- [`engine_getPayloadV5`](./methods/engine_getPayloadV5.mdx)
39+
- [`engine_getPayloadV6`](./methods/engine_getPayloadV6.mdx)
40+
- [`engine_newPayloadV1`](./methods/engine_newPayloadV1.mdx)
41+
- [`engine_newPayloadV2`](./methods/engine_newPayloadV2.mdx)
42+
- [`engine_newPayloadV3`](./methods/engine_newPayloadV3.mdx)
43+
- [`engine_newPayloadV4`](./methods/engine_newPayloadV4.mdx)
44+
- [`engine_newPayloadV5`](./methods/engine_newPayloadV5.mdx)
45+
- [`eth_accounts`](./methods/eth_accounts.mdx)
46+
- [`eth_blobBaseFee`](./methods/eth_blobBaseFee.mdx)
47+
- [`eth_blockNumber`](./methods/eth_blockNumber.mdx)
48+
- [`eth_call`](./methods/eth_call.mdx)
49+
- [`eth_chainId`](./methods/eth_chainId.mdx)
50+
- [`eth_coinbase`](./methods/eth_coinbase.mdx)
51+
- [`eth_createAccessList`](./methods/eth_createAccessList.mdx)
52+
- [`eth_estimateGas`](./methods/eth_estimateGas.mdx)
53+
- [`eth_feeHistory`](./methods/eth_feeHistory.mdx)
54+
- [`eth_gasPrice`](./methods/eth_gasPrice.mdx)
55+
- [`eth_getBalance`](./methods/eth_getBalance.mdx)
56+
- [`eth_getBlockByHash`](./methods/eth_getBlockByHash.mdx)
57+
- [`eth_getBlockByNumber`](./methods/eth_getBlockByNumber.mdx)
58+
- [`eth_getBlockReceipts`](./methods/eth_getBlockReceipts.mdx)
59+
- [`eth_getBlockTransactionCountByHash`](./methods/eth_getBlockTransactionCountByHash.mdx)
60+
- [`eth_getBlockTransactionCountByNumber`](./methods/eth_getBlockTransactionCountByNumber.mdx)
61+
- [`eth_getCode`](./methods/eth_getCode.mdx)
62+
- [`eth_getFilterChanges`](./methods/eth_getFilterChanges.mdx)
63+
- [`eth_getFilterLogs`](./methods/eth_getFilterLogs.mdx)
64+
- [`eth_getLogs`](./methods/eth_getLogs.mdx)
65+
- [`eth_getProof`](./methods/eth_getProof.mdx)
66+
- [`eth_getStorageAt`](./methods/eth_getStorageAt.mdx)
67+
- [`eth_getTransactionByBlockHashAndIndex`](./methods/eth_getTransactionByBlockHashAndIndex.mdx)
68+
- [`eth_getTransactionByBlockNumberAndIndex`](./methods/eth_getTransactionByBlockNumberAndIndex.mdx)
69+
- [`eth_getTransactionByHash`](./methods/eth_getTransactionByHash.mdx)
70+
- [`eth_getTransactionCount`](./methods/eth_getTransactionCount.mdx)
71+
- [`eth_getTransactionReceipt`](./methods/eth_getTransactionReceipt.mdx)
72+
- [`eth_getUncleCountByBlockHash`](./methods/eth_getUncleCountByBlockHash.mdx)
73+
- [`eth_getUncleCountByBlockNumber`](./methods/eth_getUncleCountByBlockNumber.mdx)
74+
- [`eth_maxPriorityFeePerGas`](./methods/eth_maxPriorityFeePerGas.mdx)
75+
- [`eth_newBlockFilter`](./methods/eth_newBlockFilter.mdx)
76+
- [`eth_newFilter`](./methods/eth_newFilter.mdx)
77+
- [`eth_newPendingTransactionFilter`](./methods/eth_newPendingTransactionFilter.mdx)
78+
- [`eth_sendRawTransaction`](./methods/eth_sendRawTransaction.mdx)
79+
- [`eth_sendTransaction`](./methods/eth_sendTransaction.mdx)
80+
- [`eth_sign`](./methods/eth_sign.mdx)
81+
- [`eth_signTransaction`](./methods/eth_signTransaction.mdx)
82+
- [`eth_simulateV1`](./methods/eth_simulateV1.mdx)
83+
- [`eth_syncing`](./methods/eth_syncing.mdx)
84+
- [`eth_uninstallFilter`](./methods/eth_uninstallFilter.mdx)
85+
86+
## Schemas
87+
88+
_No schemas defined._

0 commit comments

Comments
 (0)