mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-21 13:03:22 +00:00
sammyette
e5eefb1d2d
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
27 lines
568 B
Markdown
27 lines
568 B
Markdown
---
|
|
title: Module terminal
|
|
description: low level terminal library
|
|
layout: doc
|
|
menu:
|
|
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
|
|
|