https://github.com/kirtan403/bookmark-github-stars
Generate Bookmarks export file (html) of the github user's starred repos
https://github.com/kirtan403/bookmark-github-stars
Last synced: 9 days ago
JSON representation
Generate Bookmarks export file (html) of the github user's starred repos
- Host: GitHub
- URL: https://github.com/kirtan403/bookmark-github-stars
- Owner: kirtan403
- License: mit
- Created: 2017-01-21T10:47:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-21T11:27:21.000Z (about 8 years ago)
- Last Synced: 2024-11-05T23:41:22.115Z (5 months ago)
- Language: JavaScript
- Homepage: https://kirtan403.github.io/bookmark-github-stars/
- Size: 480 KB
- Stars: 64
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - kirtan403/bookmark-github-stars - Generate Bookmarks export file (html) of the github user's starred repos (JavaScript)
- awesome-starz - kirtan403/bookmark-github-stars - Generate Bookmarks export file (html) of the github user's starred repos (JavaScript)
README
# Github Stars as bookmarks
This retrieves github starred repos' URLs of a given user and exports them as HTML bookmarks export file, so that you can import it to your browser or your any favorite online bookmarking sites which supports HTML file imports.
# Usage
**Tip:** Head over to https://kirtan403.github.io/bookmark-github-stars/ and get started.
To use this in a `node`, use `module.js` file, require the module file and use `getAllStarredRepos` function:
```
getAllStarredRepos('username-here',function(err,html) {
if(err) {
console.log("Error: " + err);
}
// You have your bookmarks html content in html variable
// You can save it or use it however you like
});
```
For using this in `browser`, we have converted this module using browserify.
Just download `bookmark-github-stars-browser.js` file and use it the same way you may use with node. After including this with script tag, you can use this with like this:
```
bookmarkGithubStars.getAllStarredRepos(user, function(err, data) {
if (err) {
// An error
console.log("There is an error");
return;
}
// You have your bookmarks html content in html variable
// You can save it or use it however you like
});
```
Check `index.html` for example.
# Build
The main file is `module.js` which contains the source code.
To generate the browser js file, use the below code.
If you do not have `browserify` install, download it first, else skip this step.
```
npm install -g browserify
```
Now generate `bookmark-github-stars-browser.js` using `module.js` file:
```
browserify module.js --standalone bookmarkGithubStars -o bookmark-github-stars-browser.js
```
Done.