readme banners

[docs] [github]

Your name, or your project's, in block letters that glint, type in or hold still: an animated SVG for a GitHub README, which runs no script, or the same on a page and in a terminal. Pick a font, a shadow, a colour or a fade, a tagline typed out under it, and any of the library's 73 logos, companies and distros beside it. Everything here is an option in code too: the docs have every one.

light

dark

use it

html

<a href="https://ascii.rest/banner/">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://ascii.rest/banner/ascii.rest.dark.svg">
    <img alt="ascii.rest" src="https://ascii.rest/banner/ascii.rest.svg">
  </picture>
</a>

markdown

[![ascii.rest](https://ascii.rest/banner/ascii.rest.svg)](https://ascii.rest/banner/)

url

https://ascii.rest/banner/ascii.rest.svg

react

import { Banner } from "ascii.rest/react";

<Banner text="ascii.rest" />

svg

import { bannerSvg } from "ascii.rest/svg";

const light = bannerSvg("ascii.rest");
const dark = bannerSvg("ascii.rest", { dark: true });

terminal

npx ascii.rest banner 'ascii.rest'

cli

import { banner } from "ascii.rest/terminal";

await banner("ascii.rest");

The URL is the banner: https://ascii.rest/banner/<text>.svg, and .dark.svg for GitHub's dark theme. Up to 20 characters: letters, digits, spaces and . , ! ? ' : - + = / _, in capitals, or as you type them in mixed. The query carries the rest, and the docs list every key. React, the SVG from your own code and the terminal take each choice as an option, and many more: see banner() and bannerSvg(). Anyone who prefers reduced motion gets it still.