Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v0.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

AutoDoc

AutoDoc is a home for your notes. It keeps a folder of Markdown files as they are, and gives them an editor, search by words and by meaning, the links between them, and room for AI agents to work beside you.

  • Your files stay yours. The notes are plain Markdown on your disk. AutoDoc's index of them lives elsewhere, follows every change, and can always be rebuilt from the files.
  • One program, many ways in. autodoc --ui runs in your terminal and autodoc --gui opens a window of its own; Neovim, plugins and AI agents reach the same notes through autodoc --call.
  • An editor for reading and writing. A page centred on the screen, Vim or ordinary keys, diagrams, charts and tables drawn in place, and every note one key away.
  • Search that understands. By words, or with a model by meaning, ordered again by a reranker.
  • The links between notes. What a note links to and what links to it, a mind map of its neighbours, and the whole workspace as a map.
  • Agents and plugins. AI agents' command lines in a panel, told about your workspace; plugins, such as the AutoDB SQL workbench, that run beside your notes.

Where to go next

Documentation

Index

Constants

This section is empty.

Variables

View Source
var CommandsReference string

CommandsReference is available on the installed binary with --commands-reference.

View Source
var KeymapReference string

KeymapReference is available on the installed binary with --keymap-reference.

View Source
var ThemeReference string

ThemeReference is available on the installed binary with --theme-reference.

View Source
var Tutorials embed.FS

Tutorials are the short tutorials (tutorials/NN-name.md, README.md their index and no page) and their translations (tutorials/<tag>/NN-name.md, a UI language's tag): AutoDoc's Help › Tutorial shows them in their files' order, in the UI's language, and the docs site publishes the English files (a section is its folder's *.md, so the translations are none of it).

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL