Connect new project

If you have a new Wiki (or documentation) repository for your project to connect, please follow these steps:

  1. Define a new git source in the build script:
    • setup wiki page aliases in lowercase using the valid URI STD66 format (e.g. cp Contribution.md contribution.md)
    • prefer the webroot location if your project has no alternative branches (e.g. /twister-seeder, /twisterad)
  2. Create a new menu item in the book summary that will be used in the navigation menu
  3. Send a pull request with your connection!

Formatting

Please follow these recommendations when creating or editing content:

  • exclude remote content dependencies, such as status badges, images, and other media that require a remote connection to function; if the media file is required, it should be associated with your upstream repository for cloning;
  • prefer absolute URLs for local referencing, as the book route may be different;
  • this book supports GitHub Flavored Markdown's Alerts - feel free to decorate the content semantically!

Edit existing sources

This project uses build.sh to aggregate the book data from different sources.
If you want to make any changes, please submit your edits to the relevant Wiki providers:

Feel free to open an Issue if you have any questions!

Run the mirror

Make the book accessible to others by setting up an additional repository or web mirror for online reading!

Repository mirror

Some self-hosted repository providers, such as Gitea, allow you to easily clone the upstream repository using web UI and create a mirror out of the box. Follow the software documentation for details!

Alternatively, you can set up your own public (or private) repository by running:

git clone https://github.com/twisterarmy/book.git

and then set up the auto-updates using crontab and git pull command (example).

Web mirror for online reading

The upstream repository contains a precompiled HTML version in the /book directory, which you can set up as the web root in your nginx or Apache web server.

important

When running the web mirror, make sure the repository root (which contains the .git directory) is located above the web root directory!

Update the mirror with crontab

For daily auto-updates, consider using a crontab task with the git pull command running from the cloned book project:

@daily cd /var/www/book && /usr/bin/git pull
  • if the repository is located at /var/www/book and its HTML version is located in the original book directory
  • for more crontab examples, visit this beautiful guide

Announce new mirror

If you're the public mirror maintainer, feel free to share your link with others on the Releases page in the Mirrors section!