Northstar Wiki Repo

Warning

The GitBook based NorthstarWiki has been deprecated in favour of the NorthstarDocs where this wiki has been integrated.

Check it out here: https://docs.northstar.tf/Wiki/

The source for the NorthstarDocs can be found here: https://github.com/R2Northstar/NorthstarDocs

This repo contains documentation around the Northstar mod, a Titanfall 2 mod to join and host custom community servers.

The docs/ directory contains the content synchronised to the GitBook Wiki page.

Use this repo to perform pull requests and open issues to request changes to the wiki content.

Building locally

Unfortunately, GitBook does not offer a way to work and preview edited content locally.

However, under the hood GitBook just uses Markdown files that can be edited using any text editor. They can also be previewed to some degree on GitHub directly.

mdBook

When working locally, mdBook can be used to render previews by simply running mdbook serve. Note that GitBook has a custom extended markdown syntax that is not supported by mdBook but using mdBook results in a rendered version that is good enough to verify the correctness of most changes.

To install mdBook use the following link if:

• you have Rust toolchain installed
• you DON'T have Rust toolchain installed

mdBook-linkcheck

Additionally there's a community-made package that you can use alongside mdBook to show you some potentially broken links in markdown files called mdBook-linkcheck

Although not required, you may find it helpful to use alongside mdBook to ensure you've linked things properly

To install mdBook-linkcheck use the following link if:

• you have Rust toolchain installed
• you DON'T have Rust toolchain installed (add mdBook-linkcheck.exe to the same folder mdBook.exe is located)