DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (f47094b3b694)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
# About this documentation

This guide is built with MarkDown files and [GitBook](https://github.com/GitbookIO/gitbook).

The source code for this documentation is distributed with the source code for the tools, in the `docs/` folder.

If you want to contribute to the documentation, [clone the repository](./getting-started/build.md#getting-the-code), make your changes locally, and then regenerate the book to see how it looks like before submitting a patch:

```bash
# Install GitBook locally
npm install -g gitbook-cli

# Go into the docs directory
cd /path/to/mozilla-central/devtools/docs/

# Install plugins
gitbook install

# Generate the docs and start a local server
gitbook serve

# You can now navigate to localhost:4000 in your browser to see the output
open http://localhost:4000 # this would work in MacOS

# Or build the book only (this places the output into `docs/_book`)
gitbook build
```