nushell/reedline
1
1
Fork 0
mirror of https://github.com/nushell/reedline.git synced 2024-08-17 11:50:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

README.md outline cleanup (#466)

Browse Source 
- Fixed anchor links (some links were not pointing to correct headings).
- Updated headings (some headings in outline didn't match the content).
- Fixed heading level for "Integrate with History" (was 2 should be 3).
This commit is contained in:
morzel85 2022-08-22 10:06:33 +02:00 committed by GitHub
parent b11109bbe8
commit d4ab1a753f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -14,15 +14,15 @@ It is currently primarily developed as the interactive editor for [nushell](http
## Outline
- [Examples](#examples)
- [Quickstart example](#basic-example)
- [Keybinding configuration example](#integrate-with-custom-keybindings)
- [History example](#integrate-with-history)
- [Syntax highlighting example](#integrate-with-custom-syntax-highlighter)
- [Interactive tab-completion example](#integrate-with-custom-tab-completion)
- [Fish-style history autosuggestions](#integrate-with-hinter-for-fish-style-history-autosuggestions)
- [Line validation example](#integrate-with-custom-line-completion-validator)
- [Vi-style edit mode example](#integrate-with-custom-edit-mode)
- [Development status](#are-we-prompt-yet-development-status)
- [Basic example](#basic-example)
- [Integrate with custom keybindings](#integrate-with-custom-keybindings)
- [Integrate with `History`](#integrate-with-history)
- [Integrate with custom syntax `Highlighter`](#integrate-with-custom-syntax-highlighter)
- [Integrate with custom tab completion](#integrate-with-custom-tab-completion)
- [Integrate with `Hinter` for fish-style history autosuggestions](#integrate-with-hinter-for-fish-style-history-autosuggestions)
- [Integrate with custom line completion `Validator`](#integrate-with-custom-line-completion-validator)
- [Use custom `EditMode`](#use-custom-editmode)
- [Are we prompt yet? (Development status)](#are-we-prompt-yet-development-status)
- [Contributing](./CONTRIBUTING.md)
- [Alternatives](#alternatives)
@ -81,7 +81,7 @@ keybindings.add_binding(
let mut line_editor = Reedline::create().with_keybindings(keybindings);
```
## Integrate with `History`
### Integrate with `History`
```rust,no_run
// Create a reedline object with history support, including history size limits