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

31 lines
652 B
Markdown
Raw Normal View History

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 04:00:54 +00:00
---
title: Interface hilbish.editor
description: interactions for Hilbish's line reader
layout: doc
menu:
docs:
parent: "API"
---
## Introduction
The hilbish.editor interface provides functions to
directly interact with the line editor in use.
## Functions
docs: [ci] generate new docs
2023-02-07 22:19:24 +00:00
### getLine() -> string
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 04:00:54 +00:00
Returns the current input line.
docs: [ci] generate new docs
2023-02-07 22:19:24 +00:00
### getVimRegister(register) -> string
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 04:00:54 +00:00
Returns the text that is at the register.
### insert(text)
Inserts text into the line.
feat: hilbish native pager (#240)
2023-10-25 04:41:53 +00:00
### getChar() -> string
Reads a keystroke from the user. This is in a format
of something like Ctrl-L..
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 04:00:54 +00:00
### setVimRegister(register, text)
Sets the vim register at `register` to hold the passed text.