https://github.com/AashishRichhariya/openleaf
openleaf is a minimalist, browser-based text editor that lets you start writing instantly without signup, downloads, or configuration. Just go to any URL and start typing!
https://github.com/AashishRichhariya/openleaf
browser-editor collaborative-editing distraction-free instant-notes lexical-editor markdown-editor minimal minimalist-design no-login no-signup note-taking open-source rich-text-editor text-editor writing-tool
Last synced: about 1 year ago
JSON representation
openleaf is a minimalist, browser-based text editor that lets you start writing instantly without signup, downloads, or configuration. Just go to any URL and start typing!
- Host: GitHub
- URL: https://github.com/AashishRichhariya/openleaf
- Owner: AashishRichhariya
- License: mit
- Created: 2025-02-16T05:30:58.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-05-02T07:40:25.000Z (about 1 year ago)
- Last Synced: 2025-05-02T08:40:02.792Z (about 1 year ago)
- Topics: browser-editor, collaborative-editing, distraction-free, instant-notes, lexical-editor, markdown-editor, minimal, minimalist-design, no-login, no-signup, note-taking, open-source, rich-text-editor, text-editor, writing-tool
- Language: TypeScript
- Homepage: https://openleaf.xyz/info
- Size: 276 KB
- Stars: 45
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openleaf
[](https://opensource.org/licenses/MIT)
[](https://github.com/AashishRichhariya/openleaf)
[](https://openleaf.xyz/info)
[](https://github.com/AashishRichhariya/openleaf/pulls)
## The minimalist web-based editor
**openleaf** is a minimalist, browser-based text editor that lets you start writing instantly without signup, downloads, or configuration. Just go to any URL and start typing!
Check it out: [openleaf.xyz/info](https://openleaf.xyz/info)
## How It Works
- Visit any link like `openleaf.xyz/anything-you-want`
- Start typing immediately
- The content automatically saves as you type
- Share the URL with others or return later to continue
## Features
### Markdown Syntax
**openleaf** supports markdown shortcuts for quick formatting (type the symbol then press space to activate):
- Type `#` for a large heading
- Type `##` for a medium heading
- Type `###` for a small heading
- Type `-` for bullet points
- Type `1.` for numbered lists
- Type `>` for blockquotes
- Type `[]` or `[x]` for checklist items
- Type `[text](url)` to create links
### Command Menu
Press `/` to access the command menu with all available formatting options:
- Headings (3 levels)
- Lists (numbered, bulleted, checklist)
- Tables
- Quotes
- Code blocks (coming soon!)
- Text alignment (coming soon!)
- And more!
### Tables
Create tables easily by either:
- Type `/table` and select from the menu
- Or type `/NxM` where N and M are any numbers (like `/3x4`, `/2x6`, etc.) to instantly create a table with that many rows and columns
### Links
Create links easily in multiple ways:
- Type `[text](url)` using markdown syntax
- Type any URL, such as `https://openleaf.xyz` or `www.openleaf.xyz`, to have it automatically detected as a link
- Select text and paste a URL (Cmd+V or Ctrl+V) to turn the selected text into a link
### Checklists
Keep track of tasks with checkable lists:
- [x] Create a minimalist editor
- [x] Make it work without signup with a simple url
- [x] Add Markdown support
- [x] Add table support
- [x] Open-source it
- [ ] Fix bugs
- [ ] Add more features!
## Philosophy
**openleaf** is designed with simplicity in mind:
> The best tool is the one that gets out of your way.
The goal is to provide a writing space that's instantly available when needed, without barriers or complexity. Sometimes all you need is a quick place to jot down thoughts or draft something up.
## Privacy & Security
By design, **openleaf** is open and accessible. This means:
- Anyone with the URL can view and edit your content
- Nothing is private by default
- Choose obscure URLs for reduced discoverability
- Don't store sensitive information
- For extra security, clear the editor content after you're done if you don't want others to access it later
## Use Cases
### Perfect for:
- Quick notes while browsing
- Drafting emails or messages
- Temporary information sharing
- Collaborative brainstorming
- Instant document creation
### Not ideal for:
- Private/confidential information
- Long-term document storage
## Project Status
**openleaf** is currently in beta with known bugs and limitations. Development continues as time permits, with priority given to critical issues and frequently requested features. Please use the GitHub repository to report any bugs you encounter.
## Contribute to openleaf
This project is open source under the MIT license. Contributions and feedback are welcome on [GitHub](https://github.com/AashishRichhariya/openleaf)!
- 🐛 Found a bug? [Open an issue](https://github.com/AashishRichhariya/openleaf/issues)
- 💡 Have a feature idea? [Share it with us](https://github.com/AashishRichhariya/openleaf/issues)
- 💻 Want to contribute code? [Check out our guidelines](CONTRIBUTING.md)
- ⭐ Enjoying openleaf? Spread the word or star us on [GitHub](https://github.com/AashishRichhariya/openleaf)!
## Technical Details
**openleaf** is built with:
- [Lexical](https://lexical.dev/) - Meta's open-sourced text editor framework
- [Next.js](https://nextjs.org/) - Full stack React framework with TypeScript
- [Tailwind CSS](https://tailwindcss.com/) - For styling
- [DynamoDB](https://aws.amazon.com/dynamodb/) - For storage
## Future Possibilities
If interest grows, potential future features might include:
- Optional user accounts
- Private and published notes
- Image support
- Temporary URL leasing (lock a URL for your exclusive use for a set period)
- More formatting options
- PDF exporting and printing
- Real-time collaboration indicators
## Installation
```bash
# Clone the repository
git clone https://github.com/AashishRichhariya/openleaf.git
# Navigate to the project directory
cd openleaf
# Install dependencies
pnpm install
# Run the development server
pnpm dev
```
## License
**openleaf** is licensed under the [MIT License](LICENSE).