diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /devtools/docs/about-documentation.md | |
parent | Initial commit. (diff) | |
download | firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/docs/about-documentation.md')
-rw-r--r-- | devtools/docs/about-documentation.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/devtools/docs/about-documentation.md b/devtools/docs/about-documentation.md new file mode 100644 index 0000000000..fece8a6ee4 --- /dev/null +++ b/devtools/docs/about-documentation.md @@ -0,0 +1,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 +``` |