mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-03 09:44:17 +00:00
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
28 lines
515 B
Markdown
28 lines
515 B
Markdown
---
|
|
title: Interface hilbish.history
|
|
description: command history
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
The history interface deals with command history.
|
|
This includes the ability to override functions to change the main
|
|
method of saving history.
|
|
|
|
## Functions
|
|
### add(cmd)
|
|
Adds a command to the history.
|
|
|
|
### clear()
|
|
Deletes all commands from the history.
|
|
|
|
### get(idx)
|
|
Retrieves a command from the history based on the `idx`.
|
|
|
|
### size()
|
|
Returns the amount of commands in the history.
|
|
|