Skip to content

Commit

Permalink
add Code of Conduct info and link to README
Browse files Browse the repository at this point in the history
  • Loading branch information
graphitefriction committed Apr 8, 2021
1 parent a8537e1 commit c270c77
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ You can see a preview of the default UI at {url-preview}.
While the default UI is ready to be used with Antora, the intent is that you'll fork it and customize it for your own needs.
It's intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize.

== Code of Conduct

The Antora project and its project spaces are governed by our https://gitlab.com/antora/antora/-/blob/master/CODE-OF-CONDUCT.adoc[Code of Conduct].
By participating, you're agreeing to honor this code.
Let's work together to make this a welcoming, professional, inclusive, and safe environment for everyone.

== Use the Default UI

If you want to simply use the default UI for your Antora-generated site, add the following UI configuration to your playbook:
Expand Down Expand Up @@ -195,15 +201,15 @@ These map files sit adjacent to the combined files in the build folder.
The mapping they provide allows the debugger to present the original source rather than the obfuscated file, an essential tool for debugging.

In preview mode, source maps are enabled automatically, so there's nothing you have to do to make use of them.
If you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment varible to `true` when you run the bundle command:
If you need to include source maps in the bundle, you can do so by setting the `SOURCEMAPS` environment variable to `true` when you run the bundle command:

$ SOURCEMAPS=true gulp bundle

In this case, the bundle will include the source maps, which can be used for debuggging your production site.
In this case, the bundle will include the source maps, which can be used for debugging your production site.

== Copyright and License

Copyright (C) 2017-2019 OpenDevise Inc. and the Antora Project.
Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.

Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).
See link:LICENSE[] to find the full license text.
Expand Down

0 comments on commit c270c77

Please sign in to comment.