Localization styleguides
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
.editorconfig
.gitignore
.travis.yml
README.md
book.json
package-lock.json
package.json

README.md

Style Guides

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.

Updating the documentation

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

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

GitBook

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

If you want to build and preview the GitBook locally, install npm and and run the following commands from the root of the repository:

$ npm install
$ npm start