marksmith 0.0.12 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6223365f49536a9ee694cd03965e95e7ad4678f1baf8c2d5b8326b4e255f3c14
-  data.tar.gz: 300bf849b18a10fd9acedddfcfdff606e207d923d0aa9faa7f29a5e0a5703c46
+  metadata.gz: 0da9e3c49eee802cb04a55505552636af16dd6821180a049bbdcdb51d0664ed6
+  data.tar.gz: 1eddf93578ba14e3b0a79f5915f69efce8a24f28c6ce9cf4f5c94c8764f5c46b
 SHA512:
-  metadata.gz: 10a5f5e0597d1a1c4f6119e09919833d56878a94fb96dc6d50e3ca7ebc2396a8f3afdd073f9c06c2b066b185f9d22456d8f85835400b581177a440e3bc6af2cd
-  data.tar.gz: c94d8651053d3870af6ba50eabbf9d4147098a47b22e16b2341307d4074edc4118ee0c923cf58ee0eb5c326c9ce8f807d74d5ec92ce6d8f250c89df2ef572951
+  metadata.gz: a735566969ff5549736ae7588b20988f24caa424e60df3e41265d9aa9c6934175cebba2e39a51af159be790d91a99283873315beb14fcc080a7f08c7036bea3d
+  data.tar.gz: afab9a21269662a84b2b63e9ea338db62e2e399b4dcf524801510168598413cf37ceba0e8bc0fd21fe9f463d14c4ad1a4c82d04c6f65ace47a778bdddb916e13

data/README.md

@@ -27,24 +27,16 @@ Or manually install it.
 Add this line to your application's Gemfile:
 
 ```ruby
+# Gemfile
 gem "marksmith"
 ```
 
-And then execute:
-
-```bash
-bundle
-```
-
-
 ### 2. Install the NPM package to import the StimulusJS controller.
 
 Install the package.
 
 ```bash
-yarn add @avo-hq/marksmith
-# or
-npm install @avo-hq/marksmith
+$ yarn add @avo-hq/marksmith
 ```
 
 Import and register it in your application.
@@ -60,16 +52,16 @@ application.register('marksmith', MarksmithController)
 > If you want to manually import those dependencies and import only the controller from the package use the `/controller` path.
 
 ```js
-// Import just the controller
-import { MarksmithController } from '@avo-hq/marksmith/core'
-
-application.register('marksmith', MarksmithController)
-
 // Manually import Marksmith's dependencies
 import '@github/markdown-toolbar-element'
 import { DirectUpload } from '@rails/activestorage'
 import { post } from '@rails/request.js'
 import { subscribe } from '@github/paste-markdown'
+
+// Import just the controller
+import { MarksmithController } from '@avo-hq/marksmith/core'
+
+application.register('marksmith', MarksmithController)
 ```
 
 ### 3. Add the style tag to your `application.html` layout
@@ -80,16 +72,17 @@ import { subscribe } from '@github/paste-markdown'
 
 ### 4. Use it
 
-Use it a simple tag or attach it to your form builder.
+Use a form helper tag or attach it to your form builder.
 
 ```erb
 <%= marksmith_tag :body, value: "### This is important" %>
-<%= @form.marksmith @field.id%>
+or
+<%= @form.marksmith :body %>
 ```
 
 ## Options
 
-The field supports some of the regular options like `disabled`, `placeholder`, `autofocus`, `style`, `class`, `rows`, `data`, and `value`, but also a custom one.
+The field supports a few of the regular options like `disabled`, `placeholder`, `autofocus`, `style`, `class`, `rows`, `data`, and `value`, but also a custom one.
 
 `extra_preview_params` - Sends extra params to the preview renderer.
 
@@ -98,11 +91,25 @@ The field supports some of the regular options like `disabled`, `placeholder`, `
 The renderer is powered by [`Redcarpet`](https://github.com/vmg/redcarpet).
 It supports basic styles for headings, `strong`, `italic` and others.
 
+In your `show.html.erb` view or the place where you want to render the compiled markup use the `marksmithed` helper and it will run the content through the renderer.
+
+```erb
+<%= marksmithed post.body %>
+```
+
+## Using with importmap
+
+It should be as simple as running this command and have it pinned in your `importmap.rb` file.
+
+```bash
+bin/importmap pin @avo-hq/marksmith
+```
+
 ## Active Storage
 
 The field supports Actve Storage uploads using drag and drop and pasting files into the field.
 
-## List continuation
+## List Continuation
 
 Marksmith has this great opt-in feature where you can have your lists continued.
 We need to add the `ListContinuation` controller too.
@@ -121,8 +128,13 @@ application.register('list-continuation', ListContinuationController)
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+## Usage in Avo
+
+Marksmith work wonderfully in Avo throught the default [markdown field](https://docs.avohq.io/3.0/fields/markdown.html).
+
 ## Other Open-Source Work
 
 - [`active_storage-blurhash`](https://github.com/avo-hq/active_storage-blurhash) - A plug-n-play [blurhash](https://blurha.sh/) integration for images stored in ActiveStorage
@@ -133,7 +145,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Try Avo ⭐️
 
-If you enjoyed this gem try out [Avo](https://github.com/avo-hq/avo). It helps developers build Internal Tools, Admin Panels, CMSes, CRMs, and any other type of Business Apps 10x faster on top of Ruby on Rails.
+If you enjoyed this gem try out [Avo](https://github.com/avo-hq/avo). It doubles your engineering speed without hiring extra developers. Teams build Internal Tools, Admin Panels, Content Management Systems, CRMs, and other types of Business Apps 10x faster on top of Ruby on Rails using Avo.
 
 ## Troubleshooting
 

data/app/assets/config/marksmith_manifest.js

@@ -1,2 +1,3 @@
 //= link_directory ../stylesheets .css
+//= link_directory ../javascripts .js
 //= link_tree ../images