sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity
Hilbish/docs/api/terminal.md

27 lines
568 B
Markdown
Raw Normal View History

feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00
---
docs: fix yaml metadata, symlink to hugo
2022-12-15 01:05:11 +00:00
title: Module terminal
docs: push fixed docs
2022-12-03 20:54:34 +00:00
description: low level terminal library
docs: fix yaml metadata, symlink to hugo
2022-12-15 01:05:11 +00:00
layout: doc
menu:
docs:
parent: "API"
feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00
---
## Introduction
docs: push fixed docs
2022-12-03 20:54:34 +00:00
The terminal library is a simple and lower level library for certain terminal interactions.
feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00
## Functions
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### restoreState()
Restores the last saved state of the terminal
refactor: reduce duplication and reorganize code in doc gen
2022-12-03 15:15:25 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### saveState()
Saves the current state of the terminal
feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### setRaw()
Puts the terminal in raw mode
feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### 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
feat!: enhance docs and doc command 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 (soon). 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-02 19:08:03 +00:00