Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/useflyyer/docusaurus-preset
Flyyer.io integration preset for Docusaurus.io v2 | Manage your og:image from a single dashboard
https://github.com/useflyyer/docusaurus-preset
documentation docusaurus flyyer lerna og-image react seo twitter-cards typescript
Last synced: 1 day ago
JSON representation
Flyyer.io integration preset for Docusaurus.io v2 | Manage your og:image from a single dashboard
- Host: GitHub
- URL: https://github.com/useflyyer/docusaurus-preset
- Owner: useflyyer
- License: mit
- Created: 2020-12-31T15:06:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T05:11:17.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T05:44:10.868Z (7 days ago)
- Topics: documentation, docusaurus, flyyer, lerna, og-image, react, seo, twitter-cards, typescript
- Language: TypeScript
- Homepage: https://flyyer.io
- Size: 1.6 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flyyer x Docusaurus
To create dynamic image previews please refer to [docs.flyyer.io](http://docs.flyyer.io/).
**This plugin required [Docusaurus v2](https://v2.docusaurus.io/).** There is no support for v1.
**Need help? [Join our Discord](https://www.flyyer.io/discord)**
## Install
```bash
yarn add @flyyer/docusaurus-preset @flyyer/flyyer
# or with npm
npm install --save @flyyer/docusaurus-preset @flyyer/flyyer
```
On your `docusaurus.config.js` add `@flyyer/docusaurus-preset` at the end of your `presets` array:
```js
{
// ...
presets: [
// ...
[
"@flyyer/docusaurus-preset",
{
flyyer: {
/**
* Get your project's id at https://flyyer.io/dashboard/_/projects/_/integrate
*/
project: "",
}
},
],
],
}
```
### Advanced
#### Signed URLs
To prevent bad actors from generating images you can sign your URLs.
🔑 Get your **secret key** here: [flyyer.io/dashboard/_/projects/_/advanced](https://www.flyyer.io/dashboard/_/projects/_/advanced).
> Note: This key is different form your `FLYYER_KEY`.
```js
{
presets: [
[
"@flyyer/docusaurus-preset",
{
flyyer: {
project: "",
secret: process.env.FLYYER_SIGNATURE_KEY || "your-key",
strategy: "JWT", // "JWT" | "HMAC"
}
},
],
],
}
```
## Development
Clone this repository with:
```bash
git clone https://github.com/useflyyer/docusaurus-preset.git
cd docusaurus-preset
```
Install dependencies and bootstrap [Lerna](https://github.com/lerna/lerna/):
```bash
yarn install
yarn run bootstrap
```
Build packages:
```bash
yarn run build
```
## Publishing
Create a new [Lerna version](https://github.com/lerna/lerna/tree/main/commands/version#readme):
```bash
yarn run lerna version
```
Publish packages:
```bash
yarn run lerna publish from-git --yes
```
## License
MIT