Documentation
Complete guide to using 2YU Docs
Table of Contents
Getting Started
Welcome to 2YU Docs! This guide will help you get started with creating, saving, and managing your permanent notes.
Quick Start
- Open the editor and start typing your note
- Format your text using the toolbar options
- Click the "Save" button when ready to store permanently
- Follow the prompts to set up your Arweave wallet (if needed)
- Save your transaction ID to access your document later
No account or sign-up required! Just start writing and save when you're ready. Your documents are stored permanently on the Arweave blockchain.
Editor Basics
The 2YU Docs editor is built on Tiptap, a powerful rich text editor. Here's what you need to know:
Toolbar
The toolbar at the top provides quick access to formatting options. Hover over buttons to see tooltips.
Keyboard Shortcuts
Use keyboard shortcuts for faster editing:
- Ctrl/Cmd + B - Bold
- Ctrl/Cmd + I - Italic
- Ctrl/Cmd + U - Underline
- Ctrl/Cmd + K - Add link
- Ctrl/Cmd + Z - Undo
- Ctrl/Cmd + Shift + Z - Redo
Auto-save
Your work is automatically saved locally as you type. However, to store permanently on Arweave, you need to click the Save button.
Text Formatting
2YU Docs supports a wide range of text formatting options:
Headings
Use the heading dropdown to create H1-H6 headings. Perfect for structuring your documents.
Text Styles
Apply bold, italic, underline, and strikethrough to your text.
Lists
Create bulleted lists, numbered lists, and todo lists with checkboxes.
Links
Add hyperlinks to external websites or internal references using Ctrl/Cmd + K.
Images
Upload and embed images directly into your documents. Images are stored on Arweave along with your document.
Code Blocks
Add inline code or code blocks with syntax highlighting for programming languages.
Saving Documents
Saving a document permanently stores it on the Arweave blockchain. Here's how the process works:
Step-by-Step Saving Process
- 1Click the Save Button
Located in the editor toolbar, this initiates the saving process.
- 2Wallet Setup (if needed)
The app will automatically generate an Arweave wallet or use your existing one.
- 3Fund Your Wallet
If your wallet needs funding, you'll be guided through the process. Typically costs less than $0.01.
- 4Upload to Arweave
Your document is uploaded via Irys to the Arweave network.
- 5Receive Transaction ID
Save this ID - it's your permanent link to access the document.
💡 Tip: You can optionally add password protection during the save process for extra security.
Document Versioning
Every time you save a document, a new version is created. This allows you to track changes and restore previous versions.
Accessing Versions
Use the version dropdown in the editor toolbar to:
- View all previous versions of your document
- See when each version was created
- Restore any previous version
- Compare changes between versions
How Versioning Works
Each version is stored as a separate transaction on Arweave, creating a chain of document history. This ensures that:
- All versions are permanently stored
- You can access any version at any time
- Version history cannot be tampered with
- Each version has its own transaction ID
Password Protection
Add an extra layer of security to your documents with password protection. Your documents are encrypted using AES encryption before being stored on Arweave.
Setting a Password
When saving a document, you'll see an option to add password protection. Enter a strong password and confirm it.
Accessing Protected Documents
When opening a password-protected document, you'll be prompted to enter the password. Without the correct password, the document cannot be decrypted.
⚠️ Important: If you forget your password, there is no way to recover your document. Make sure to store your password securely.
Wallet Management
2YU Docs uses Arweave wallets to store and manage your documents. The wallet is stored locally in your browser.
Automatic Wallet Creation
The app automatically creates an Arweave wallet for you when you first save a document. No manual setup required!
Viewing Your Wallet
Click the wallet icon in the editor to view your wallet address and balance. You can also see all documents associated with your wallet.
Funding Your Wallet
When you need to fund your wallet, the app provides clear instructions. You can fund using AR (Arweave cryptocurrency) through various exchanges or payment methods.
Wallet Security
Your wallet is stored locally in your browser. Make sure to back up your wallet if you want to access your documents from another device. The app will provide export options when needed.
Accessing Documents
There are several ways to access your saved documents:
Using the Sidebar
The editor sidebar shows all documents associated with your wallet. Click on any document to load it into the editor.
Using Transaction ID
You can access any document using its transaction ID through:
- Direct URL:
/document/[transaction-id] - Any Arweave gateway:
arweave.net/[transaction-id] - The app's document viewer
Sharing Documents
Share your documents by sending the transaction ID or the direct URL. If the document is password-protected, make sure to share the password separately through a secure channel.
Advanced Features
Tables
Create and format tables with rows and columns. Perfect for organizing data and information.
Blockquotes
Use blockquotes to highlight important quotes or sections of text.
Text Alignment
Align your text left, center, right, or justify for professional formatting.
Text Colors
Change text color and highlight color to emphasize important information.
HTML Content
Embed custom HTML content for advanced formatting and interactive elements.
Video Embeds
Embed videos from YouTube, Vimeo, and other platforms directly into your documents.