This repository is used to store style guides for Mozilla communities. All localization style guides and related documents are listed in docs/SUMMARY.md.

If you’re reading these pages on GitHub, a version with improved readability and search capabilities is available here.

Simply open a pull request adding the new file or updating an existing document. Make sure to follow these style guidelines, and note that all pull requests need to be reviewed before merging. The instructions for creating new community style guides are part of the guidelines for community style guides. Please also run the following commands to ensure the files are correctly formatted.

$ npm install
$ npm test

The files in this repository are licensed under the Creative Commons Attribution-ShareAlike 4.0 International license unless otherwise specified in the file header. You can read more about this license here.

A version with improved readibility and search is built automatically via GitHub Actions and mdBook. Updates are pushed to the gh-pages branch and available via GitHub Pages here.

If you want to build and preview these pages locally, install Rust and cargo and then run the following commands from the root of the repository:

$ cargo install mdbook
$ cargo install mdbook-toc
$ mdbook serve

mdbook-toc is used as a preprocessor, and will install the correct version of mdBook as a dependency.

If you want content to appear on mdBook, it needs to be listed in docs/SUMMARY.md.