sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-03-13 18:00:41 +00:00
Code Issues Releases Wiki Activity
Hilbish/docs/api/terminal.md
sammyette e5eefb1d2d
refactor!: rework docs and doc command (#218) 
changes the actual file format of docs to markup since that's basically what we have been
using in the first place.

the docgen command has been modified to write markdown headings with the function name and
yaml metadata for easy consumption by hugo for the website.

all other docs have been moved to markdown as well this is the main reason this is a "breaking" change
users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 00:00:54 -04:00

568 B
Raw Blame History

title description layout menu
Module terminal low level terminal library doc
docs
parent
API

Introduction

The terminal library is a simple and lower level library for certain terminal interactions.

Functions

restoreState()

Restores the last saved state of the terminal

saveState()

Saves the current state of the terminal

setRaw()

Puts the terminal in raw mode

size()

Gets the dimensions of the terminal. Returns a table with width and height Note: this is not the size in relation to the dimensions of the display