{"id":20206513,"url":"https://github.com/useflyyer/docusaurus-preset","last_synced_at":"2026-05-12T06:34:57.143Z","repository":{"id":38426352,"uuid":"325822579","full_name":"useflyyer/docusaurus-preset","owner":"useflyyer","description":"Flyyer.io integration preset for Docusaurus.io v2 | Manage your og:image from a single dashboard","archived":false,"fork":false,"pushed_at":"2023-01-07T05:11:17.000Z","size":1677,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-14T21:03:31.288Z","etag":null,"topics":["documentation","docusaurus","flyyer","lerna","og-image","react","seo","twitter-cards","typescript"],"latest_commit_sha":null,"homepage":"https://flyyer.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/useflyyer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-31T15:06:03.000Z","updated_at":"2021-07-21T15:52:45.000Z","dependencies_parsed_at":"2023-02-06T12:30:26.875Z","dependency_job_id":null,"html_url":"https://github.com/useflyyer/docusaurus-preset","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fdocusaurus-preset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fdocusaurus-preset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fdocusaurus-preset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useflyyer%2Fdocusaurus-preset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/useflyyer","download_url":"https://codeload.github.com/useflyyer/docusaurus-preset/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241644542,"owners_count":19996177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","docusaurus","flyyer","lerna","og-image","react","seo","twitter-cards","typescript"],"created_at":"2024-11-14T05:24:32.104Z","updated_at":"2026-05-12T06:34:57.031Z","avatar_url":"https://github.com/useflyyer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flyyer x Docusaurus\n\nTo create dynamic image previews please refer to [docs.flyyer.io](http://docs.flyyer.io/).\n\n**This plugin required [Docusaurus v2](https://v2.docusaurus.io/).** There is no support for v1.\n\n**Need help? [Join our Discord](https://www.flyyer.io/discord)**\n\n## Install\n\n```bash\nyarn add @flyyer/docusaurus-preset @flyyer/flyyer\n\n# or with npm\nnpm install --save @flyyer/docusaurus-preset @flyyer/flyyer\n```\n\nOn your `docusaurus.config.js` add `@flyyer/docusaurus-preset` at the end of your `presets` array:\n\n```js\n{\n  // ...\n  presets: [\n    // ...\n    [\n      \"@flyyer/docusaurus-preset\",\n      {\n        flyyer: {\n          /**\n           * Get your project's id at https://flyyer.io/dashboard/_/projects/_/integrate\n           */\n          project: \"\",\n        }\n      },\n    ],\n  ],\n}\n```\n\n### Advanced\n\n#### Signed URLs\n\nTo prevent bad actors from generating images you can sign your URLs.\n\n🔑 Get your **secret key** here: [flyyer.io/dashboard/_/projects/_/advanced](https://www.flyyer.io/dashboard/_/projects/_/advanced).\n\n\u003e Note: This key is different form your `FLYYER_KEY`.\n\n```js\n{\n  presets: [\n    [\n      \"@flyyer/docusaurus-preset\",\n      {\n        flyyer: {\n          project: \"\",\n          secret: process.env.FLYYER_SIGNATURE_KEY || \"your-key\",\n          strategy: \"JWT\", // \"JWT\" | \"HMAC\"\n        }\n      },\n    ],\n  ],\n}\n```\n\n## Development\n\nClone this repository with:\n\n```bash\ngit clone https://github.com/useflyyer/docusaurus-preset.git\ncd docusaurus-preset\n```\n\nInstall dependencies and bootstrap [Lerna](https://github.com/lerna/lerna/):\n\n```bash\nyarn install\nyarn run bootstrap\n```\n\nBuild packages:\n\n```bash\nyarn run build\n```\n\n## Publishing\n\nCreate a new [Lerna version](https://github.com/lerna/lerna/tree/main/commands/version#readme):\n\n```bash\nyarn run lerna version\n```\n\nPublish packages:\n\n```bash\nyarn run lerna publish from-git --yes\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseflyyer%2Fdocusaurus-preset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuseflyyer%2Fdocusaurus-preset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseflyyer%2Fdocusaurus-preset/lists"}