mirror of
https://github.com/Hilbis/Hilbish
synced 2025-03-13 18:00:41 +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
527 B
Markdown
27 lines
527 B
Markdown
---
|
|
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
|
|
### getLine()
|
|
Returns the current input line.
|
|
|
|
### getVimRegister(register)
|
|
Returns the text that is at the register.
|
|
|
|
### insert(text)
|
|
Inserts text into the line.
|
|
|
|
### setVimRegister(register, text)
|
|
Sets the vim register at `register` to hold the passed text.
|
|
|