Socket
Socket
Sign inDemoInstall

embedded-github-timeline

Package Overview
Dependencies
37
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    embedded-github-timeline

Best GitHub timeline component


Version published
Weekly downloads
0
Maintainers
1
Created
Weekly downloads
 

Readme

Source

GitHub Timeline V1.0.1

Its simple use embeded GitHub timeline.Its work with api.github.

Introduce

  • Roadmap
  • Usage
  • Contributing
  • License

Roadmap

You can see what we've done before and what we will work on in the future;

  • Basic styling
  • Multiple timeline in same file
  • Responsive styling(auto detected screen size and restyling)
  • Event(start, push, commit, review etc.) icon
  • Detailed event info
  • Multiple language
  • Light/Dark theme
  • Fix size(small, medium, large) attribute
  • Auto component generator and previewer web site
  • Customizable colors

// TODO

Usage

1: Past the div on your HTML code then change the username from data-username

<div class="github-timeline" data-username="write-here-username"></div>

2: Add the external script in your body

<script src="https://cdn.jsdelivr.net/gh/saracalihan/github-timeline/js/scripts.min.js"></script>

Now its ready to work :)

Try it

Example code and screenshot

<!DOCTYPE html>
<html lang="en">
    <head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Github Timeline</title>
    <style>
        body {
        display: flex;
        flex-direction: column;
        background-color: rgb(46, 46, 46);
        }

        .examples{
        margin: auto;
        }

        .examples > div {
        margin: 10px;
        }

    </style>
    </head>

    <body>

    <div class="examples">

        <!-- Usage copy the div what has class "github-timeline" then  -->
        <div class="github-timeline" data-username="saracalihan"></div>
        <div class="github-timeline" data-username="yourUsername"></div>
        <div class="github-timeline" data-username="userNotFoundExample"></div>
    </div>


    <script src="https://cdn.jsdelivr.net/gh/saracalihan/github-timeline/js/scripts.min.js"></script>
    </body>

</html>

Example Code

Contributing

// TODO

License

GNU GENERAL PUBLIC LICENSE Version 3

Keywords

FAQs

Last updated on 23 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc