Commit 56fd70cf authored by Nick Stenning's avatar Nick Stenning

Add skeletal docs for client configuration

parent d5a04537
Configuring the sidebar
=======================
The Hypothesis sidebar can be configured by providing a settings object in the
body of the hosting page:
```html
<script type="application/json" class="js-hypothesis-config">
{
"openSidebar": true
}
</script>
<script async src="https://hypothes.is/embed.js"></script>
```
**N.B.** The body of the `.js-hypothesis-config` tag must be [valid
JSON](http://jsonlint.com/) -- invalid JSON will cause the entire config object
to be ignored.
Config keys
-----------
### `openLoginForm`
_Boolean_. Controls whether the login panel is automatically opened on startup,
as if the user had clicked "Log in" themselves.
### `openSidebar`
_Boolean_. Controls whether the sidebar opens automatically on startup.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment