Git Product home page Git Product logo

tokei_rs's Introduction

tokei.rs badge service

Scheme

tokei.rs has support for badges. For example total lines.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei_rs)](https://github.com/XAMPPRocky/tokei_rs).

Tokei's URL scheme is as follows.

https://tokei.rs/b1/<domain>[<.com>]?/<namespace>/<repository>
  • domain: The domain name of git host. If no TLD is provided .com is added. e.g. tokei.rs/b1/github == tokei.rs/b1/github.com.
  • namespace: The namespace of the repo. eg. rust-lang or XAMPPRocky.
  • repository: the name of the repo eg. rust or tokei.

Category

By default the badge will show the repo's total lines, you can also specify for it to show a different category, by using the ?category= query string. It can be either code, blanks, files, lines, or comments. Here is an example showing total number of code. lines of code.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code)](https://github.com/XAMPPRocky/tokei).

Type

You can choose to count lines only for specific language type(s), by using the ?type= query string. Languages are to be separated by a comma. Here is an example showing total number of lines for JSON, Rust, and Markdown. lines of json, rust, and markdown.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?type=JSON,Rust,Markdown)](https://github.com/XAMPPRocky/tokei).

Label

You can customize the badge label by using the ?label= query string. For example, custom label.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&label=custom%20label)](https://github.com/XAMPPRocky/tokei).

Style

By default, the badge uses the "flat" style. You can customize the badge style by using the ?style= query string. Supported styles are flat, flat-square, plastic, for-the-badge, and social. For example, custom style.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&style=for-the-badge)](https://github.com/XAMPPRocky/tokei).

Color

By default, the badge uses the color blue #007ec6. You can customize the badge color by using the ?color= query string. Supported color formats include named colors and RGB hexadecimal, a full list of supported formats can be found here. For example, custom color.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&color=ff0000)](https://github.com/XAMPPRocky/tokei).

Logo

You can customize the badge logo (SVG format) by passing its full URL to the ?logo= query string. For example, custom logo.

[![](https://tokei.rs/b1/github/XAMPPRocky/tokei?category=code&logo=https://simpleicons.org/icons/rust.svg)](https://github.com/XAMPPRocky/tokei).

Copyright and License

(C) Copyright 2018 by XAMPPRocky and contributors

See the graph for a full list of contributors.

tokei.rs is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE, LICENSE-MIT for more information.

tokei_rs's People

Contributors

3arthqu4ke avatar conao3 avatar dependabot-preview[bot] avatar dependabot[bot] avatar elliotwutingfeng avatar robjtede avatar xampprocky avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.