This repository contains the documentation content and MkDocs framework for the Wormhole documentation site. Wormhole is an interoperability platform powering multichain apps and bridges.
The CI workflows in this repository were adapted from (and inspired by) PaperMoon’s MkDocs workflows previously used for Wormhole Docs.
Original reference implementation: PaperMoon Workflows
wormhole-docs/
|--- /docs/ # Documentation content (markdown files, images, snippets)
|--- /material-overrides/ # Theme customizations and overrides
|--- /scripts/ # Build and utility scripts
|--- /py_scripts/ # Python scripts
|--- mkdocs.yml # MkDocs configuration
|--- requirements.txt # Python dependencies
To get started, install the required dependencies:
pip install -r requirements.txtTo build and serve the site locally:
mkdocs serveAfter a successful build, the site should be available at http://127.0.0.1:8000.
If you're editing any of the files in the material-overrides directory, run the following command to watch for changes and render them automatically:
mkdocs serve --watch-themeOtherwise, you'll need to stop the server (control + C) and restart it (mkdocs serve) to see the changes.
The git-revision-date-localized plugin pulls the date of the last git modification of a page. When developing locally, this can slow down your development process, as the plugin checks for the latest dates on every page each time a change is made. To avoid this, you can change your start-up command to turn off the plugin by running:
export ENABLED_GIT_REVISION_DATE=false
mkdocs serveThis repository includes AI-ready files generated from the documentation to support large language models (LLMs) and developer tools:
llms.txt: A plain-text index of all documentation pages with titles and URLs.llms-full.jsonl: The complete content of all documentation pages in a single file.<category>.md: Category-specific files for products like NTT, Token Bridge, Connect, and others.
These files power AI assistants, enable semantic code search, and integrate Wormhole docs into tools like Cursor. For details, visit the AI Resources page.
If you're interested in contributing to this repository, please feel free to clone the repo, make changes, and open a PR. Please review the guidelines in the .CONTRIBUTING.md file before making any changes.
This software and its content are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. All content is provided for educational purposes. See the License for the specific language governing permissions and limitations under the License.