A writing app for developers
Follow @voraciousdev on Twitter for updates!
- Autosave - No need to hit save
- Client-Side Encryption - Uses a hybrid cryptosystem approach to reap the benefits of both public-key and symmetric encryption
- CodeSandbox Integration - Open all code blocks in the current document in a new CodeSandbox project with the click of a button
- Context Switching - Focusing on
#work
or#play
? Apply a global filter to only see the documents that are relevant - Dark Theme - Save our eyes ๐
- Inline Markdown Rendering - No need for separate edit and preview panels
- Keybindings - Keyboard shortcuts for many actions
- Modern Technologies - Built with Vue, Vuex, and VueRouter
- Offline First - No account, server, or internet connectivity necessary (files are stored in IndexedDB, WebSQL, or LocalStorage)
- PWA - Progressive Web Apps are accessible on all platforms and installable on most
- Regular Expressions - Search our documents with plain text or regex
- Responsive - Use on desktop or mobile
- Syntax Highlighting - Code blocks are highlighted based on the tagged language
- Tag Based Organization - Add one or more hashtags to our documents, just like we would on Twitter (code blocks are ignored)
- Keybinding Configuration - Use the shortcuts that make sense to you
- Light Theme - Why not both?
- Native Apps - Install a native application on Android, iOS, or desktop (built with Ionic's Capacitor framework)
Watch a quick intro on YouTube (1m 39s)
To try out the sandboxed app (no accounts or syncing), check out try.octo.app.
As simple as it gets.
# install dependencies
npm install
We can run it in development
mode.
# binds to localhost:8888
npm run serve_dev
We can also run it in production
mode.
Note: Offline functionality is only available in production
mode due to lack of support in the Vue PWA plugin.
# binds to localhost:8889
npm run serve_prod
Create the production build.
# compiles at ./dist
npm run build_prod
The static assets will be available in the dist
directory.
Logo by Zagg Studios
Your support is appreciated.
Your feedback is immensely important for building octo into an app that we all love. Consider opening an issue if you discover any bugs or just want to chat about ideas!
If you feel comfortable tackling an existing issue, please consider opening a Pull Request! I am happy to introduce you to the codebase and work with you to get it merged!
Donations help support the development of octo (this open source project) and the hosting of octo.app.
Accounts on octo.app include syncing and persistence through Firebase. Accounts are currently free, and your financial support directly impacts how long we can keep it that way.