{"id":13704864,"url":"https://github.com/webbertakken/docusaurus-plugin-content-gists","last_synced_at":"2025-10-28T15:37:01.417Z","repository":{"id":38383441,"uuid":"492946968","full_name":"webbertakken/docusaurus-plugin-content-gists","owner":"webbertakken","description":"Display your gists inside docusaurus.","archived":false,"fork":false,"pushed_at":"2024-03-20T17:19:11.000Z","size":688,"stargazers_count":11,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T14:05:35.186Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/webbertakken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"webbertakken","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-05-16T18:05:22.000Z","updated_at":"2025-03-08T19:22:15.000Z","dependencies_parsed_at":"2024-10-23T17:09:54.928Z","dependency_job_id":null,"html_url":"https://github.com/webbertakken/docusaurus-plugin-content-gists","commit_stats":{"total_commits":27,"total_committers":2,"mean_commits":13.5,"dds":0.03703703703703709,"last_synced_commit":"d6d3c8bb8d988274ecd6475b7e65303a1f7abd47"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-gists","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-gists/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-gists/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webbertakken%2Fdocusaurus-plugin-content-gists/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webbertakken","download_url":"https://codeload.github.com/webbertakken/docusaurus-plugin-content-gists/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252892503,"owners_count":21820648,"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":[],"created_at":"2024-08-02T22:00:21.735Z","updated_at":"2025-10-28T15:37:01.412Z","avatar_url":"https://github.com/webbertakken.png","language":"TypeScript","funding_links":["https://github.com/sponsors/webbertakken"],"categories":["Plugins"],"sub_categories":["Content"],"readme":"# Docusaurus gists plugin\n\n\u003e Use gists as a type of content in Docusaurus.\n\n## Introduction\n\nThis plugin adds a page to your Docusaurus instance, displaying all _public_ gists of a GitHub user.\n\nThe user is automatically configured based on the (GitHub PAT) token provided.\n\nSee it in action on [Takken.io](https://takken.io).\n\n## ⚠️ Security Update (v4.0.0+)\n\n**Breaking Change:** For security reasons, the `personalAccessToken` option has been removed. The\nGitHub token must now be provided via the `GH_PERSONAL_ACCESS_TOKEN` environment variable only.\n\nIf you're upgrading from a previous version:\n\n1. Remove `personalAccessToken` from your plugin configuration\n2. Ensure `GH_PERSONAL_ACCESS_TOKEN` is set in your environment\n\n## Setup\n\n### Install dependencies\n\nChoose one:\n\n```bash\n# NPM\nnpm install dotenv docusaurus-plugin-content-gists\n\n# Yarn\nyarn add dotenv docusaurus-plugin-content-gists\n```\n\n### Configure\n\n#### `.gitignore`\n\n```gitignore\n.env\n```\n\n#### `.env`\n\n```env\nGH_PERSONAL_ACCESS_TOKEN=ghp_your_token_here\n```\n\n#### `docusaurus.config.js`\n\n```js\n// Import variables from both system and .env file.\nrequire('dotenv').config()\n\nconst config = {\n  // Configure plugin\n  plugins: [\n    [\n      'docusaurus-plugin-content-gists',\n      {\n        enabled: true,\n        verbose: true,\n      },\n    ],\n  ],\n\n  // Configure navbar\n  themeConfig: {\n    navbar: {\n      items: [{ to: '/gists', label: 'Gists', position: 'left' }],\n    },\n  },\n}\n```\n\n### Authentication\n\nThe plugin requires a GitHub Personal Access Token to fetch gists. For security reasons, this token\nmust be provided via the `GH_PERSONAL_ACCESS_TOKEN` environment variable.\n\n#### Creating a GitHub Personal Access Token\n\n1. Go to GitHub Settings → Developer settings → Personal access tokens →\n   [Tokens (classic)](https://github.com/settings/tokens)\n2. Click \"Generate new token\" → \"Generate new token (classic)\"\n3. Give it a descriptive name (e.g., \"Docusaurus Gists Plugin\")\n4. Select the `gist` scope (read access to gists)\n5. Click \"Generate token\" and copy the token\n\n\u003e **Security Notice:** Never pass the token directly through plugin options. Always use environment\n\u003e variables to prevent accidental exposure of your GitHub credentials in your codebase or build\n\u003e artifacts.\n\n### Options\n\n#### `enabled`\n\nWhether or not this plugin is enabled.\n\n_**required:** `false`_ _**default:** `true`_\n\n#### `verbose`\n\nGives output about retrieving the gists during build time\n\n_**required:** `false`_ _**default:** `false`_\n\n#### `gistPageComponent`\n\nWhich component to use for showing the gist page.\n\n_**required:** `false`_ _**default:** `'@theme/GistPage'`_\n\n#### `gistListPageComponent`\n\nWhich component to use for showing the gists list page.\n\n_**required:** `false`_ _**default:** `'@theme/GistListPage''`_\n\n## Contributing\n\nContributions are welcome!\n\nPlease read the [contributing guide](./CONTRIBUTING.md).\n\n## License\n\n[MIT](./LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-gists","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-gists","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebbertakken%2Fdocusaurus-plugin-content-gists/lists"}