/commits-widget-darkmode

Dark Mode fork for TylerLH's github commit activity widget

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Contributors Stargazers MIT License


dark mode icon

Dark Mode for TylerLH's Latest Commits Widget

Fork of TylerLH's Latest Commits Widget

Modified CSS file to change the colors to a material design dark mode and disable scrollbar (and keep functionality).

About

Product Name Screen Shot

Show the latest commit activity on your repo, keeping the community updated and giving users more incentive to contribute to your project with this widget.

Check out a demo of the widget in action @ Sample

Forked from TylerLH's master branch

Tasks

  • Material Design Dark Mode
  • Adaptable Width and/or Height
  • Add a toggle for light and dark mode?

Usage

This widget is hosted via GitHub Pages, meaning all you need to do is include an iframe in your html and you're good to go. There are 4 params at the moment: USERNAME, REPO, BRANCH, and LIMIT.

<iframe src="https://eunai.github.io/commits-widget-darkmode/?username=USERNAME&repo=REPO&limit=LIMIT"
  allowtransparency="true" frameborder="0" scrolling="no" width="502px" height="252px"></iframe>

Parameters

USERNAME
GitHub username that owns the repo (required)

REPO
GitHub repository to check for activity (required)

BRANCH
Branch to pull commits from (default: master)

LIMIT
The maximum number of results to list (default: 10)

Things to Note

  • Width and height are hardcoded. Be sure to specify the default values (500x250) in your iframe and overload those values in the css if you want to change them.

  • The widget currently depends on jquery and jquery.timeago at the moment.

Bug Tracker

Have a bug? Open a new issue at https://github.com/tylerlh/github-latest-commits-widget/issues

Copyright & License

Distributed under the Apache License, Version 2.0. See LICENSE.txt for more information.

Copyright 2012-2020 Tyler Hughes.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact

Francis - @retiredbarista - GitHub

Acknowledgements