https://github.com/a7ul/gitbook-plugin-expo-snack
A gitbook plugin to add expo snacks
https://github.com/a7ul/gitbook-plugin-expo-snack
expo gitbook open-library plugin snack
Last synced: 3 months ago
JSON representation
A gitbook plugin to add expo snacks
- Host: GitHub
- URL: https://github.com/a7ul/gitbook-plugin-expo-snack
- Owner: a7ul
- Created: 2017-12-09T10:25:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-09T17:13:57.000Z (over 7 years ago)
- Last Synced: 2024-10-15T04:33:20.622Z (8 months ago)
- Topics: expo, gitbook, open-library, plugin, snack
- Language: JavaScript
- Size: 421 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gitbook-plugin-expo-snack
A gitbook plugin to include expo snack to your documentations/books
### Instructions
In your `book.json`
```
{
"plugins": ["expo-snack"]
}
```
### Usage:
To use the snack viewer
1. Generate a snack url in expo.io
2. Then use it as follows
```
{% exposnack %}
snack url
{% endexposnack %}
```
**For example:**
```
{% exposnack %}
@master-atul/test
{% endexposnack %}
```
### Screenshot
#### Advanced:
```
{% exposnack
platform="ios"
preview="true"
theme="dark"
hideCorrectLink="false"
style="overflow:hidden;background:#212733;border:1px solid rgba(0,0,0,.16);border-radius:4px;height:600px;width:100%
%}
@master-atul/test
{% endexposnack %}
```
*The above mentioned example is the default*
#### Options:
- platform=`"android" | "ios"`
- preview=`"true|false"`
- theme="`light|dark`"
- style=`"overflow:hidden;background:#212733;"`
- hideCorrectLink="`false|true`" `// Expo web embed widget has incorrect implementation of open external link to the original snack. The plugin by default adds the correct link icon on the right but u can choose to hide it.`