Documentation

Browse Project Documentation

Select the Documentation group in the sidebar to find every .md and .mdx file beneath the project root. The pane expands by itself the first time you visit it in a session. Terminay groups documents by folder, excludes hidden, dependency, and generated-output directories, and refreshes the tree when files change.

Indexing runs in the background and carries on if you collapse the pane or switch sidebar groups. While it runs, the pane header shows a spinner with a stop button; stopping keeps the documents already listed. Use Reload documentation in the header to rescan.

YAML frontmatter can provide a document title. When no title is present, Terminay turns the filename into a readable title without renaming the underlying file.

Open From Anywhere

Markdown and MDX files open in the Documentation view wherever you open them from: the Documentation tree, the file explorer, a folder tab, dragging a file to the tab area, or a link in another document. Links to other .md and .mdx files in the project open as documents, and external links open in your browser.

Choose View source in the toolbar to switch the same tab to the file viewer, with its Preview, Tasks, Text, HEX, and Diff modes. Pending edits are saved first. In the file viewer, Open as document switches back. A file has one tab either way, so the two views never hold competing drafts.

Rich Markdown Editing

Open a document from the tree to edit it with headings, emphasis, lists, links, images, tables, code blocks, frontmatter, directives, and other Markdown and MDX constructs. The toolbar also switches between rich text, source, and diff modes.

Opening a document does not change it. When you edit, Terminay saves the document as the editor holds it, so a paragraph that was hard-wrapped over several lines is written back on one line. The words, headings, lists, tables, and code blocks are unchanged.

On Desktop, document text follows View > Zoom In, Zoom Out, and Reset Zoom along with your terminals.

Autosave And Conflicts

Documentation edits save automatically after one second of inactivity. Terminay serializes saves, reports saving and conflict states, and keeps the draft available when a save fails or the file changes externally.

Switching between rich, source, and diff views does not itself rewrite the file. Save state is shown in the status bar at the bottom of the tab. Text and HEX editing in the file viewer is not autosaved and keeps its explicit save.

MDX Preview

.mdx documents show a live preview beside the editor, or below it in a narrow tab. The preview compiles project React and TypeScript components in an isolated browser runtime, and a compile or runtime error is reported in the tab without affecting the editor or your draft. Preview code receives browser capabilities without gaining Node, Electron, terminal, secret, or unrestricted filesystem access.