Pink is a command-line tool inspired by the Unix man command.

Related tags

Command-line pink
Overview

Pink

pink is a command-line tool inspired by the Unix man command. It displays custom-formatted text pages in the terminal using a subset of HTML-like tags.

Current Working Tested OS's ⚙ī¸

  • macOS Ventura 13.6
  • FreeBSD 13.2

Features 🎨

  • Custom Formatting: Apply styles such as bold, italic, underline, and color to text.
  • Pink Tags: Use a subset of HTML-like tags tailored for terminal display.
  • Easy to Use: Simply run pink to display a formatted text page.

Installation 🛠ī¸

To install pink, you need to have Rust and Cargo installed on your system. If you haven't already installed Rust, you can do so by following the instructions on the official Rust website.

Once Rust and Cargo are installed, follow these steps to build, install, and set up pink:

  1. Clone the repository and navigate to the project directory:

    git clone https://github.com/KatahGii/pink.git
    cd pink
  2. Build the project:

    cargo build --release
  3. Run the installation script (you might need to give it execute permissions first):

    chmod +x install.sh
    ./install.sh

    This script will:

    • Create the necessary directories.
    • Add the default pink.pink file.
    • Move the compiled binary to a directory in your PATH.

Usage 🚀

To display a formatted text page, run:

pink <filename>

Tag Usage 🏷ī¸

pink utilizes a subset of HTML-like tags, referred to as "pink tags", to apply styles to the text. Here is a brief overview:

  • ...: Makes the enclosed text bold.
  • ...: Makes the enclosed text italic.
  • ...: Underlines the enclosed text.
  • ...: Changes the text color to pink.
  • ...

    ,

    ...

    ,

    ...

    : Apply heading styles. (more info in the pink.pink file)

Contributing đŸ‘Ĩ

Contributions are welcome! Feel free to open an issue or submit a pull request.

License 📜

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

You might also like...
A lightweight terminal tool to manage processes in Unix machines.

TTV v0.0.1 TTV (term-task-viewer) is a lightweight tool to view and manage active processes in Unix machines. It provides an easy interface with vim-l

Reviving the Research Edition Unix speak command

This repository contains the source code of Unix speak program that appeared in the Third (1973) to Sixth (1975) Research Unix editions, slightly adjusted to run on a modern computer. Details on the code's provenance and the methods employed for reviving it can be found in this blog post.

fcp is a significantly faster alternative to the classic Unix cp(1) command
fcp is a significantly faster alternative to the classic Unix cp(1) command

A significantly faster alternative to the classic Unix cp(1) command, copying large files and directories in a fraction of the time.

xcp is a (partial) clone of the Unix cp command. It is not intended as a full replacement

xcp is a (partial) clone of the Unix cp command. It is not intended as a full replacement, but as a companion utility with some more user-friendly feedback and some optimisations that make sense under certain tasks (see below).

A command line tool written in Rust and designed to be a modern build tool + package manager for C/C++ projects.

CCake CCake is a command line tool written in Rust and designed to be a modern build tool + package manager for C/C++ projects. Goals To be easily und

Rust File Management CLI is a command-line tool written in Rust that provides essential file management functionalities. Whether you're working with files or directories, this tool simplifies common file operations with ease.

Rust FileOps Rust File Management CLI is a command-line tool written in Rust that provides essential file management functionalities. Whether you're w

Command-line HTTP client for sending a POST request to specified URI on each stdin line.

line2httppost Simple tool to read lines from stdin and post each line as separate POST request to a specified URL (TCP connection is reused though). G

A Rust curses library, supports Unix platforms and Windows

pancurses pancurses is a curses library for Rust that supports both Linux and Windows by abstracting away the backend that it uses (ncurses-rs and pdc

Spawn multiple concurrent unix terminals in Discord

Using this bot can be exceedingly dangerous since you're basically granting people direct access to your shell.

Owner
null
Rollback netcode for Mega Man Battle Network!

Tango Tango is rollback netplay for Mega Man Battle Network. Supported games MEGAMAN6_FXXBR6E: Mega Man Battle Network 6: Cybeast Falzar (US) MEGAMAN6

Tango 68 Dec 31, 2022
Mod for Mega Man Battle Network Legacy Collection to restore the WWW base music in the postgame.

MMBNLC Postgame WWW Base Music mod This is a mod for Mega Man Battle Network Legacy Collection Vol. 2 adjusts the field music played in the WWW base i

Prof. 9 3 May 7, 2023
A mansplainer for man commands, cheeky and rude, use at your own risk

mansplain mansplain is a Command-Line Interface (CLI) tool built in Rust that mansplains a command to you Prerequisites Rust and Cargo installed An Op

Pratik Kanthi 3 Oct 24, 2023
A more compact and intuitive ASCII table in your terminal: an alternative to "man 7 ascii" and "ascii"

asciit A more compact and intuitive ASCII table in your terminal: an alternative to man 7 ascii and ascii. Colored numbers and letters are much more e

Qichen Liu åˆ˜å¯čž° 5 Nov 16, 2023
Rust no-BS Dead Man's Switch TUI

Dead Man's Switch This is a simple implementation of a Dead Man's Switch. Use at your own risk. Check the f****(as in friendly) code. Dead man's switc

Jose Storopoli 7 Apr 25, 2024
A command-line tool for patching shell scripts inspired by resholve

patsh A command-line tool for patching shell scripts inspired by resholve nix run github:nix-community/patsh -- -f script.sh Usage Usage: patsh [OPTIO

Nix community projects 23 Jan 7, 2023
Small command-line tool to switch monitor inputs from command line

swmon Small command-line tool to switch monitor inputs from command line Installation git clone https://github.com/cr1901/swmon cargo install --path .

William D. Jones 5 Aug 20, 2022
A system clipboard command line tools which inspired by pbcopy & pbpaste but better to use.

rclip A command line tool which supports copy a file contents to the system clipboard or copy the contents of the system clipboard to a file. Install

yahaa 3 May 30, 2022
A tool for automating terminal applications in Unix.

expectrl A tool for automating terminal applications in Unix. Using the library you can: Spawn process Control process Expect/Verify responces It was

Maxim Zhiburt 132 Dec 14, 2022
Modern file system navigation tool on Unix

monat -- Modern file system Navigator įŽ€äŊ“中文 Introduction monat is a Unix shell auxiliary command focusing on the navigation of the file system, especia

Pavinberg 8 May 10, 2022