A hackable, offline-first markdown editor for notes, code snippets, and writing that runs entirely in-browser.
[](https://octo.app) ## Features ### Dark and Light Themes Dark theme by default. Light theme if you want it. 😎 ### Inline Markdown Rendering and Automatic Syntax Highlighting All Markdown formatting is rendered in place. This eliminates the need for a preview pane while keeping your document in plain text. Feel free to copy and paste your Markdown into or out of this editor! Code blocks are automatically highlighted based on the tagged language. ### Client-Side Encryption Uses a [hybrid cryptosystem](https://en.wikipedia.org/wiki/Hybrid_cryptosystem) approach to reap the benefits of both public-key and symmetric encryption. ### Keyboard Friendly and Searchable Keyboard shortcuts are available for many actions. Search documents with plain text or regex. ### Context Switching Focusing on `#work` or `#play`? Apply a global filter to only see the documents that are relevant in a given moment. ### Offline First and Mobile First (Responsive) No account, server, or internet connectivity necessary (after first load). The entire app is cached in the browser using Service Workers. Documents are stored in IndexedDB. All features of the app are built for mobile and desktop. The design changes responsively based on available screen real estate. ### Modern Technologies Built with Vue, Vuex, and VueRouter. Progressive Web Apps are accessible on all platforms and installable on many. ### Tag-based Organization and Networked Thought Add as many hashtags to your documents as you like. Build a network of information and explore your knowledgebase just as you would explore your own memories.  ## Demo [Watch a quick intro on YouTube](https://youtu.be/Brtvzu-3qT8) (1m 39s) To try out the sandboxed app (no accounts or syncing), check out [try.octo.app](https://try.octo.app). ## Install As simple as it gets. ```shell # install dependencies yarn install ``` ## Local Development We can run it in `development` mode. ```shell # binds to localhost:8888 yarn serve_dev ``` We can also run it in `production` mode. _Note: Offline functionality is only available in `production` mode due to [lack of support](https://github.com/vuejs/vue-cli/issues/2678) in the Vue PWA plugin._ ```shell # binds to localhost:8889 yarn serve_prod ``` ## Compile to Static Assets Create the production build. ```shell # compiles at ./dist yarn build_prod ``` The static assets will be available in the `dist` directory. ## Attributions Logo by Zagg Studios ## Support Your support is appreciated. Here are some ways you can help. ♥️ ### Provide Feedback Your feedback is immensely important for building octo into an app that we all love. Consider [starting a discussion](https://github.com/writewithocto/octo/discussions) if you have a question or just want to chat about ideas! ### Open a Pull Request If you feel comfortable tackling [an existing issue](https://github.com/writewithocto/octo/issues), please consider opening a Pull Request! I am happy to introduce you to the codebase and work with you to get it merged! ### Donate Donations help support the development of octo (this open source project) and the hosting of [octo.app](https://octo.app). Accounts on [octo.app](https://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. Check out our awesome Backers in [BACKERS.md](https://github.com/writewithocto/octo/blob/main/BACKERS.md). - [GitHub Sponsors](https://github.com/sponsors/voraciousdev) - [Patreon](https://patreon.com/voraciousdev) - [Ko-Fi](https://ko-fi.com/voraciousdev) - [Buy Me a Coffee](https://www.buymeacoffee.com/voraciousdev) --- _Source: https://npm.io/package/@voraciousdev/octo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._