Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vivshaw/octopug
Pug mixin to automagically add @tholman's awesome GitHub corners
https://github.com/vivshaw/octopug
github github-corner pug
Last synced: 28 days ago
JSON representation
Pug mixin to automagically add @tholman's awesome GitHub corners
- Host: GitHub
- URL: https://github.com/vivshaw/octopug
- Owner: vivshaw
- License: mit
- Created: 2017-03-04T01:01:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-04T04:38:04.000Z (almost 8 years ago)
- Last Synced: 2024-11-14T14:29:27.576Z (about 1 month ago)
- Topics: github, github-corner, pug
- Language: HTML
- Homepage: https://www.npmjs.com/package/octopug
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# octopug. :dog:
Pug mixin for [tholman's GitHub corner](http://tholman.com/github-corners/)! Now you can add a stylish GitHub link to your Node projects as easy as `npm install`.
All credit for the awesome GitHub corner design goes of course to its creator, [Tim Holman](https://github.com/tholman). I merely Pugified it, wrapped it in a mixin, and set it up for npm deployment.
## Usage
```
npm install --save octopug
```
Then add to whichever Pug file you want it on:
```
include /node_modules/octopug/octopug.pug
+octopug('https://github.com/YOUR-REPO-HERE', bgColor, catColor)
```
`bgColor` & `catColor` should be strings containing a CSS color.
`bgColor` defaults to `'#000'`, `catColor` defaults to `'#fff'`.
## License & Acknowledgements
Not built or endorsed by GitHub; just a fan. Octocat logo belongs to & represents GitHub.
GitHub corner design (c) 2016 Tim Holman - [http://tholman.com](http://tholman.com)