gecko-dev/devtools/docs/README.md
sole 0af285b498 Bug 1365216 - DevTools: bring over documentation for how to find documentation into the tree. r=pbro
MozReview-Commit-ID: 1dTTTVBB59k

--HG--
extra : rebase_source : 9e4af46b13ff7ef93f318abbb8e9f54b539a037a
2017-05-16 13:18:48 +01:00

1.1 KiB

Firefox Developer Tools

Hello!

This documentation is for developers who want to work on the developer tools. Get started here.

If you are looking for end user documentation, check out this MDN page instead.

Happy developing!

About this documentation

This guide is built with MarkDown files and 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, make your changes locally, and then regenerate the book to see how it looks like before submitting a patch:

# Install GitBook locally
npm install -g gitbook-cli

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

# Generate the docs and start a local server
gitbook serve

# You can now navigate to localhost:4000 to see the output

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