Skip to content

presets.md

Latest commit

 

History

History
761 lines (670 loc) · 54 KB

presets.md

File metadata and controls

761 lines (670 loc) · 54 KB

Presets

documentation

Table for displaying dedicated documentations with images, uptime status, and URLs.

Required Keys:

  • title
  • imageUrl
  • uptimeRobotId
  • githubUserName
  • githubRepository
  • url

Table:

Title Uptime Url
https://docs.statosio.com/
https://docs.statosio.com/

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "documentation",
    "projects": [
        {
            "title": "Statosio",
            "imageUrl": "https://docs.statosio.com/assets/images/statosio.png",
            "uptimeRobotId": "m786809205-43089a21ef2cbf3c086bad86",
            "githubUserName": "a6b8",
            "githubRepository": "statosio-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        },
        {
            "title": "Write Invoice",
            "imageUrl": "https://docs.writeinvoice.com/assets/images/logo.png",
            "uptimeRobotId": "m790382405-ad7bffbdf0263dd6daec2d27",
            "githubUserName": "a6b8",
            "githubRepository": "write-invoice-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

documentationRepository

Table for displaying website repositories with images, uptime status, GitHub repository details, and URLs.

Required Keys:

  • title
  • imageUrl
  • uptimeRobotId
  • githubUserName
  • githubRepository
  • url

Table:

Title Updated Uptime Release Workflow Url
Statosio https://docs.statosio.com/
Write Invoice https://docs.statosio.com/

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "documentationRepository",
    "projects": [
        {
            "title": "Statosio",
            "imageUrl": "https://docs.statosio.com/assets/images/statosio.png",
            "uptimeRobotId": "m786809205-43089a21ef2cbf3c086bad86",
            "githubUserName": "a6b8",
            "githubRepository": "statosio-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        },
        {
            "title": "Write Invoice",
            "imageUrl": "https://docs.writeinvoice.com/assets/images/logo.png",
            "uptimeRobotId": "m790382405-ad7bffbdf0263dd6daec2d27",
            "githubUserName": "a6b8",
            "githubRepository": "write-invoice-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

documentationRepositoryCircleCi

Table for displaying website repositories with images, uptime status, GitHub repository details, and URLs.

Required Keys:

  • title
  • imageUrl
  • uptimeRobotId
  • githubUserName
  • githubRepository
  • url

Table:

Title Updated Uptime Release Tests Url
Statosio https://docs.statosio.com/
Write Invoice https://docs.statosio.com/

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "documentationRepositoryCircleCi",
    "projects": [
        {
            "title": "Statosio",
            "imageUrl": "https://docs.statosio.com/assets/images/statosio.png",
            "uptimeRobotId": "m786809205-43089a21ef2cbf3c086bad86",
            "githubUserName": "a6b8",
            "githubRepository": "statosio-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        },
        {
            "title": "Write Invoice",
            "imageUrl": "https://docs.writeinvoice.com/assets/images/logo.png",
            "uptimeRobotId": "m790382405-ad7bffbdf0263dd6daec2d27",
            "githubUserName": "a6b8",
            "githubRepository": "write-invoice-for-ruby",
            "url": "https://docs.statosio.com/",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

dynamicPackageSearch

Table for GitHub with dynamic search for package.json, including last updated date, Total Stars, Total File Size, Total File Count, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository
  • jsonPath

Table:

Title Updated Package
Easy Mina
Mina Data

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "dynamicPackageSearch",
    "projects": [
        {
            "title": "Easy Mina",
            "githubUserName": "EasyMina",
            "githubRepository": "easyMina",
            "jsonPath": "dependencies.o1js",
            "githubBranch": "main"
        },
        {
            "title": "Mina Data",
            "githubUserName": "EasyMina",
            "githubRepository": "minaData",
            "jsonPath": "dependencies.o1js",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

gemPackages

Table for Ruby Gem Packages with version number, latest update, total download numbers, and license.

Required Keys:

  • title
  • packageName
  • githubUserName
  • githubRepository

Table:

Title Version Updated Statistics License
Feed Into
Masked Ape Club

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "gemPackages",
    "projects": [
        {
            "title": "Feed Into",
            "packageName": "feed_into",
            "githubUserName": "a6b8",
            "githubRepository": "feed-into-for-ruby",
            "githubBranch": "main"
        },
        {
            "title": "Masked Ape Club",
            "packageName": "masked_ape_club",
            "githubUserName": "a6b8",
            "githubRepository": "masked-ape-club-for-ruby",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

gemPackagesCircleCi

Table for Ruby Gem Packages with version number, latest update, total download numbers, license, and test integration via CircleCI.

Required Keys:

  • title
  • packageName
  • githubUserName
  • githubRepository

Table:

Title Version Updated Statistics Tests License
Feed Into
Masked Ape Club

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "gemPackagesCircleCi",
    "projects": [
        {
            "title": "Feed Into",
            "packageName": "feed_into",
            "githubUserName": "a6b8",
            "githubRepository": "feed-into-for-ruby",
            "githubBranch": "main"
        },
        {
            "title": "Masked Ape Club",
            "packageName": "masked_ape_club",
            "githubUserName": "a6b8",
            "githubRepository": "masked-ape-club-for-ruby",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubActivity

Table for GitHub Activity Stats like Total Stars, Total Commits, Total Contributors, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated Stars Commits Contributors License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubActivity",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubAdvanced

Table for GitHub Statistics and Activity, including Total Stars, Total Commits, Total Contributors, Total File Size, Total File Count, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated Stars Commits Contributors Files Size License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubAdvanced",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubDetails

null

Required Keys:

  • title
  • githubUserName
  • githubRepository
  • githubWorkflowPath

Table:

Title Updated Release Workflow Issues License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubDetails",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubWorkflowPath": "test-on-release.yml",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubWorkflowPath": "test-on-release.yml",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubDetailsCircleCi

null

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated Release Tests Issues License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubDetailsCircleCi",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubDetailsCodeCoverage

null

Required Keys:

  • title
  • githubUserName
  • githubRepository
  • githubWorkflowPath

Table:

Title Updated Release Workflow Issues License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubDetailsCodeCoverage",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubWorkflowPath": "test-on-release.yml",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubWorkflowPath": "test-on-release.yml",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubMinimal

Table for GitHub with the last update date and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubMinimal",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubOverview

Table for GitHub Statistics and Activity, including Total Stars, Total Commits, Tests, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated Stars Commits Issues Tests License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubOverview",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubOverviewWithArticle

Table for GitHub Statistics and Activity, including Total Stars, Total Commits, Tests, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository
  • url

Table:

Title Article Updated Stars Commits Issues Tests License
Ascii to svg Generator
Badge Table X

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubOverviewWithArticle",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "url": "",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "url": "https://medium.com/@a6b8",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

githubStats

Table for GitHub Statistics such as Stars, Total File Size, Total File Count, and License.

Required Keys:

  • title
  • githubUserName
  • githubRepository

Table:

Title Updated Stars Files Size License
Ascii to svg Generator
Badge Table

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "githubStats",
    "projects": [
        {
            "title": "Ascii to svg Generator",
            "githubUserName": "flowmcp",
            "githubRepository": "flowmcp-core",
            "githubBranch": "main"
        },
        {
            "title": "Badge Table",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

npmPackages

Table for Node.js Packages with version number, latest update, total download numbers, and license.

Required Keys:

  • title
  • packageName
  • githubUserName
  • githubRepository

Table:

Title Version Updated Statistics License
Badge Table
Easy Mina

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "npmPackages",
    "projects": [
        {
            "title": "Badge Table",
            "packageName": "badgetable",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        },
        {
            "title": "Easy Mina",
            "packageName": "easymina",
            "githubUserName": "EasyMina",
            "githubRepository": "easyMina",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

npmPackagesCircleCi

Table for Node.js Packages with version number, latest update, total download numbers, license, and integration via CircleCI.

Required Keys:

  • title
  • packageName
  • githubUserName
  • githubRepository

Table:

Title Version Updated Statistics Tests License
Badge Table
Easy Mina

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "npmPackagesCircleCi",
    "projects": [
        {
            "title": "Badge Table",
            "packageName": "badgetable",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "githubBranch": "main"
        },
        {
            "title": "Easy Mina",
            "packageName": "easymina",
            "githubUserName": "EasyMina",
            "githubRepository": "easyMina",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )

npmPackagesCircleCiWithArticle

Table for Node.js Packages with version number, latest update, total download numbers, license, and integration via CircleCI.

Required Keys:

  • title
  • packageName
  • githubUserName
  • githubRepository
  • url

Table:

Title Article Version Updated Statistics Tests License
Badge Table X
Easy Mina

Code:

import { BadgeTable } from 'badgetable'
const badgeTable = new BadgeTable()
const values = {
    "preset": "npmPackagesCircleCiWithArticle",
    "projects": [
        {
            "title": "Badge Table",
            "packageName": "badgetable",
            "githubUserName": "a6b8",
            "githubRepository": "badgeTable",
            "url": "https://medium.com/@a6b8",
            "githubBranch": "main"
        },
        {
            "title": "Easy Mina",
            "packageName": "easymina",
            "githubUserName": "EasyMina",
            "githubRepository": "easyMina",
            "url": "",
            "githubBranch": "main"
        }
    ]
}
badgeTable.getTable( values )