{"repo":"avo-hq/marksmith","free":true,"listed":false,"github":"https://github.com/avo-hq/marksmith","clone":"git clone https://github.com/avo-hq/marksmith.git","description":"GitHub-style markdown editor for Ruby and Rails","language":"JavaScript","stars":554,"topics":["editor","markdown","markdown-editor","rails","ruby","ruby-on-rails","wysiwyg-editor"],"license":"MIT","category":"productivity","readme_excerpt":"Marksmith Marksmith is a GitHub-style markdown editor for Rails apps. It supports Active Storage attachments and comes with a built-in markdown preview renderer. [!WARNING] Marksmith is at the initial stage of development. It's nearing a beta release, but the API might change and bugs are expected. Please continue to use the library and report any issues in the GitHub repo. Temporary live demo here, under the description field: https://main.avodemo.com/avo/resources/projects/new Usage Installation Prerequisites Marksmith integrates with Rails apps using Stimulus controllers and Turbo Streams, so the following must already be installed and configured: - @hotwired/stimulus package - @hotwired/turbo package - turbo-rails gem 1. Add marksmith to your Gemfile Have Bundler add it by running this command: Or manually install it. Add this line to your application's Gemfile: 2. Install the NPM package to import the StimulusJS controller. Install the package from npmjs.org. Or pin it using importmap. Import and register the controllers in your application. The ListContinuationController is optional and only needed if you want to have continued lists in your markdown. [!NOTE] Marksmith comes bundled with a few dependencies by default. If you want to manually import those dependencies and import only the controller from the package use the /controller path. 3. Add the style tag to your application.html layout 4. Use it Use a form helper tag or attach it to your form builder. The value is","default_branch":null,"files":null,"tree":[],"storefront":"/r/avo-hq","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/avo-hq/marksmith/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}