{"id":22864286,"url":"https://github.com/getnacelle/vuepress-plugin-github-markdown","last_synced_at":"2026-04-18T07:31:51.201Z","repository":{"id":40714995,"uuid":"274258709","full_name":"getnacelle/vuepress-plugin-github-markdown","owner":"getnacelle","description":"VuePress plugin for importing markdown from Github","archived":false,"fork":false,"pushed_at":"2023-01-10T01:09:44.000Z","size":1354,"stargazers_count":0,"open_issues_count":15,"forks_count":0,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-09-21T07:57:09.295Z","etag":null,"topics":["github","npm-package","vuepress-plugin"],"latest_commit_sha":null,"homepage":"","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/getnacelle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-06-22T22:53:27.000Z","updated_at":"2021-01-22T22:41:35.000Z","dependencies_parsed_at":"2023-02-08T16:16:18.497Z","dependency_job_id":null,"html_url":"https://github.com/getnacelle/vuepress-plugin-github-markdown","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/getnacelle/vuepress-plugin-github-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnacelle%2Fvuepress-plugin-github-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnacelle%2Fvuepress-plugin-github-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnacelle%2Fvuepress-plugin-github-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnacelle%2Fvuepress-plugin-github-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getnacelle","download_url":"https://codeload.github.com/getnacelle/vuepress-plugin-github-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnacelle%2Fvuepress-plugin-github-markdown/sbom","scorecard":{"id":424464,"data":{"date":"2025-08-11","repo":{"name":"github.com/getnacelle/vuepress-plugin-github-markdown","commit":"bc0fafab43d7da3efe1545b07ecb61ac9f70be05"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 1/12 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 8 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"45 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33","Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959","Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T01:57:09.794Z","repository_id":40714995,"created_at":"2025-08-19T01:57:09.794Z","updated_at":"2025-08-19T01:57:09.794Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31961108,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["github","npm-package","vuepress-plugin"],"created_at":"2024-12-13T11:19:52.560Z","updated_at":"2026-04-18T07:31:51.175Z","avatar_url":"https://github.com/getnacelle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vuepress-plugin-github-markdown\n\n\u003e VuePress plugin for importing markdown from Github\n\n## Setup\n\n### Create Github App for Organization:\n\n1. [Register new Github App](https://github.com/organizations/H2Know/settings/apps/new)\n  - Please follow [guide](https://developer.github.com/apps/building-github-apps/creating-a-github-app/) if you have questions.\n  - Make sure to save the **Private Key** that is generated to your .env file `GITHUB_PRIVATE_KEY`.\n      - May need to format the Private Key properly on single line for env file (The OSX script will format \u0026 save to clipboard for easy pasting):\n\n        `awk -v ORS='\\\\n' '1' github-app-name.2020-06-21.private-key.pem | pbcopy`\n      - Some deployment services (ie. Netlify) won't be able to parse the line breaks properly. When calling the env variable replace the line breaks like this: `process.env.GITHUB_PRIVATE_KEY.replace(/\\\\n/gm, '\\n')`.\n  - Also save the **App ID** to your .env file `GITHUB_APP_ID`.\n\n2. Install Github App\n  - Please follow [guide](https://developer.github.com/apps/installing-github-apps/) for installation.\n  - On the installation page of the app, make note of the **Installation ID**** at the end of the url. (ie. `https://github.com/organizations/getnacelle/settings/installations/**9762656**`). Save to your .env file `GITHUB_INSTALLATION_ID`\n\n### Installation:\n\n`npm install -D vuepress-plugin-github-markdown`\n\n### Add to `.vuepress/config`:\n\n```\n  plugins: [\n    [\n      'vuepress-plugin-github-markdown',\n      {\n        appId: process.env.GITHUB_APP_ID,\n        privateKey: process.env.GITHUB_PRIVATE_KEY.replace(/\\\\n/gm, '\\n'),\n        installationId: process.env.GITHUB_INSTALLATION_ID,\n        files: [\n          {\n            path: '/nuxt/changelog.html',\n            owner: 'getnacelle',\n            repo: 'nacelle-nuxt-starter',\n            githubFilePath: 'CHANGELOG.md',\n            modifyContent(content) {\n              // Append title to markdown\n              return '# @nacelle/nacelle-nuxt-starter' + '\\n' + content\n            }\n          }\n        ]\n      }\n    ]\n  ]\n```\n\n#### Plugin Options:\n\n| Name | Param[Type] | Describe |\n| ---- | --------- | -------- |\n| appId | String | App ID for Github App |\n| privateKey | String | Private Key of Github App |\n| installationId | String | ID of Github App installation |\n| files | File[] | Array of file options for markdown files to import |\n\n#### File Options:\n\n| Name | Param[Type] | Describe |\n| ---- | --------- | -------- |\n| path | String | url path where the page will live in docs |\n| owner | String | github owner/organization |\n| repo | String | github repo name |\n| githubFilePath | String | the url to the raw markdown file |\n| modifyContent | (String): String | (optional) A function that can modify imported content if needed |\n\n\n## Link to Markdown File in Sidebar:\n\nWe can link to the markdown file by using a standard sidebar group in the `config.js`:\n\n```\n  {\n    title: 'Changelog',\n    collapsable: true,\n    path: '/nuxt/changelog',\n    sidebarDepth: 1,\n    children: ['/nuxt/changelog'],\n  },\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetnacelle%2Fvuepress-plugin-github-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetnacelle%2Fvuepress-plugin-github-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetnacelle%2Fvuepress-plugin-github-markdown/lists"}