This repository has been archived by the owner on Jun 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add deployment info and writing tips to README
- Loading branch information
Showing
1 changed file
with
14 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,19 @@ | ||
# Bisq Network Documentation | ||
|
||
These are the sources for the docs hosted at https://docs.bisq.network. | ||
AsciiDoc sources for the docs hosted at <https://docs.bisq.network>. | ||
|
||
To build these docs locally, clone this repository and run | ||
## Build | ||
|
||
./gradlew build | ||
To build locally, run `./gradlew build` and then open `build/asciidoc/html5/index.html` in your browser. | ||
|
||
Then open `build/asciidoc/html5/index.html` in your browser. | ||
## Deploy | ||
|
||
Commits pushed to the `master` branch of this repository are automatically built and deployed via Netlify at <https://app.netlify.com/sites/bisq-network-docs> (permission required). | ||
|
||
## Tips | ||
|
||
- Keep the [Asciidoctor user manual][1] handy as a reference when editing. | ||
- Install the [Asciidoctor.js Live Preview][2] Chrome extension for instant in-browser rendering of `.adoc` files. This avoids the need to run `gradle build` and then refresh your browser to see the results of your changes. | ||
|
||
[1]: https://asciidoctor.org/docs/user-manual | ||
[2]: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei |