README.md

Welcome

Welcome to the Beaker Browser documentation!

{% page-ref page="getting-started-with-beaker.md" %}

Beginner

• Creating New Hyperdrives
• Changing a Drive's Title or Thumbnail
• Using the Editor
• Detaching the Editor
• Creating Files and Folders
• Importing and Exporting Files
• Sharing Hyperdrives
• Hosting Hyperdrives

Intermediate

• Your Profile Drive
• Your Address Book
• Your System Drive

Advanced

• Webterm. Beaker's terminal environment.
• Creating Mounts
• Editing File Metadata
• Forking Hyperdrives
• Comparing and Merging Hyperdrives

APIs

• beaker.capabilities. Create temporary, revocable URLs which map to hyperdrives.
• beaker.contacts. Read and manage the user's address book.
• beaker.hyperdrive. Methods to read and write Hyperdrive data.
• beaker.markdown. Render Markdown into HTML.
• beaker.peersockets. Send and receive messages to peers on a hyperdrive.
• beaker.shell. Global user interface methods, typically user dialogs.
• beaker.terminal. Register commands which are accessible from Webterm.

Developers

• Introduction to Hyperdrive
• Index.json Manifest. Information about the Hyperdrive manifest file, index.json.
• Content-Type Negotiation. How hyper:// handles URLs without extensions.
• Frontends (.ui folder). A tool to inject HTML output into every browsed resource.
• .Goto Files. Files which act like shortcuts.