Skip to content

dzmbs/hyperliquid-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hyperliquid-docs

docs updated pages sync

Community mirror of Hyperliquid documentation, automatically synced every 3 hours.

Built for AI coding agents — works with Claude Code, Codex, Cursor, Copilot, Amp, Windsurf, Cline, Aider, and any tool that reads markdown.

What's in here

All Hyperliquid documentation as markdown files in docs/, preserving the original structure:

Section Path Description
Onboarding docs/onboarding/ Getting started, deposits, testnet
HyperCore docs/hypercore/ L1 architecture, bridge, staking, vaults
Trading docs/trading/ Fees, margining, order types, liquidations
HyperEVM docs/for-developers/hyperevm/ EVM dev docs, precompiles, RPC
API docs/for-developers/api/ REST, WebSocket, signing, rate limits
Nodes docs/for-developers/nodes/ Running nodes, data schemas
HIPs docs/hyperliquid-improvement-proposals-hips/ Protocol improvement proposals
Builder Tools docs/builder-tools/ Ecosystem tooling
Support docs/support/faq/ FAQ & troubleshooting

How it works

A GitHub Action runs every 3 hours:

  1. Parses the Gitbook sitemap index to discover all pages
  2. Fetches markdown via Gitbook's .md endpoint
  3. Commits any changes

Using with AI coding tools

Claude Code

Clone into your project or reference as context:

git clone https://github.com/dzmbs/hyperliquid-docs.git

The CLAUDE.md file tells Claude where to find everything.

Codex / Copilot / Amp / Cursor / Windsurf

The AGENTS.md file provides the universal context. Clone or add as a submodule.

Any tool

Just point your agent at the docs/ directory — it's plain markdown.

Local sync

# Fetch latest docs locally
uv run scripts/fetch_docs.py

License

This project mirrors publicly available documentation from Hyperliquid. All documentation content is the property of Hyperliquid. This mirror is provided for convenience and is not affiliated with or endorsed by Hyperliquid.

About

Mirror of Hyperliquid documentation, automatically synced every 3 hours.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages