# uberfire-docs

## How to edit the docs

- Fork the repository https://github.com/uberfire/uberfire then clone the fork locally
- Get gitbook editor from https://github.com/GitbookIO/editor-legacy
- Get gitbook builder from https://github.com/GitbookIO/gitbook (you may need to install npm first)
- Edit the docs in your forked repository ../uberfire/uberfire-docs in gitbook editor
- When you've finished editing, build the docs by running uberfire-docs/buildHtml.sh and uberfire-docs/buildPdf.sh
- View the built docs in uberfire-docs/docs/_book/index.html and uberfire-docs/uberfire-docs.pdf
- Submit a pull request to get your changes accepted
