Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-17 15:25:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1349256 - Added docs about how to generate the gitbook; r=sole

Browse Source 
MozReview-Commit-ID: 9pa0rXaLehZ

--HG--
extra : rebase_source : df5e5024d9774cbfba700a98751a5ae2adeb6184
This commit is contained in:
Patrick Brosset 2017-03-21 15:19:20 +01:00
parent 0a1d6164e3
commit ebe91ed432
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
devtools/docs/README.md
View File

@ -6,4 +6,19 @@ If you are looking for general docs about how to use the tools, checkout [this M
If you are looking for a getting started guide on the developer tools, all of this information is documented on the [Hacking](https://wiki.mozilla.org/DevTools/Hacking) wiki page.
Head over to the [table of contents](SUMMARY.md) to browse the documentation.
[GitBook](https://github.com/GitbookIO/gitbook) is used to generate online documentation from the markdown files here.
Here is how you can re-generate the book:
```bash
# 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
# Or just built the book
gitbook build
```