README.md

Mkdocs Framework and Material Theme for the Wormhole Docs

This repo contains the Mkdocs config files, theme overrides, and custom CSS for the Wormhole documentation site.

• Mkdocs
• Material for Mkdocs

The actual content is stored in the wormhole-docs repo and pulled into the wormhole-docs directory during build.

• Wormhole Docs

Install Dependencies

To get started, you need to install mkdocs. All dependencies, including mkdocs, can be installed with a single command; you can run:

pip install -r requirements.txt

Getting Started

For everything to work correctly, the file structure needs to be as follows:

wormhole-mkdocs
|--- /material-overrides/ (folder)
|--- /wormhole-docs/ (submodule)
|--- mkdocs.yml

To set up the structure, follow these steps:

1. Clone this repository:

   git clone https://github.com/papermoonio/wormhole-mkdocs

2. Inside the folder just created, initialize and update the wormhole-docs repository:

   cd wormhole-mkdocs
   git submodule init && git submodule update

3. In the wormhole-mkdocs folder (which should be the current one), you can build the site by running:

   mkdocs serve

After a successful build, the site should be available at http://127.0.0.1:8000.

Editing Theme Files

If you're editing any of the files in the material-overrides directory, you can run the following command to watch for these changes and render them automatically:

mkdocs serve --watch-theme

Otherwise, you'll need to stop the server (control + C) and restart it (mkdocs serve) to see the changes.