repos2md:将GitHub用户的存储库列表导出到.md文件

repos2md [](https://badge.fury.io/js/repos2md) -- > Export GutHub user repos list to a markdown file. [](https://nodei.co/npm/repos2md/) [](https://nodei.co/npm/repos2md/) ## install ```bash # globally ❯ yarn global add repos2md # or in project ❯ yarn add repos2md ``` ## usage ### `cli` ```bash ❯ repos2md --help Export repos list to a markdown file. repos2md v2.0.0 Usage $ repos2md <username> $ repos2md <username> --save-to <path> --token <token> --exclude-repos-count Options --starred optional (default is user repos) If provided, user's starred repos will be fetched --save-to optional (defaults to project root) Absolute path to the target file (.md document) to write to --token optional (includes private repos) Your GitHub token (if you want to inclide private repos) --exclude-repos-count optional Exclude repos count from heading in target file Examples $ repos2md frenchbread $ repos2md frenchbread --starred --save-to /Users/frenchbread/Desktop --exclude-repos-count ``` ### `nodejs` ```js const repos2md from 'repos2md' repos2md('github') .then(saved_to => console.log(`Repos saved to "${saved_to}"`)) ``` ## api ### repos2md(github_username, options?) Returns `<path>` to where file has been saved. #### options type: `object` - **starred** type: `boolean` Fetch user's starred repos. - **save_to** type: `string` Custom path to where write file to. Can be both relative & absolute. - **token** type: `string` GitHub [token](https://github.com/settings/tokens), used to include private repos. - **exclude_repos_count** type: `boolean` Exclude repos count from target doc. ### **note!** > For unauthenticated requests, the rate limit allows for up to 60 requests per hour. Unauthenticated requests are associated with the originating IP address, and not the user making requests. > > [Source](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) ### todos - [x] Change input username/path approach - [x] Write & add tests - [x] Handle paths containing `~` > Contributions are welcome! ### author - Damir Mustafin [@frenchbread](https://github.com/frenchbread) ### license [MIT](https://github.com/frenchbread/repos2md/blob/master/LICENSE)