marksmith 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +60 -0
  4. data/Rakefile +8 -0
  5. data/app/assets/config/marksmith_manifest.js +2 -0
  6. data/app/assets/images/marksmith/svgs/bold.svg +3 -0
  7. data/app/assets/images/marksmith/svgs/code.svg +3 -0
  8. data/app/assets/images/marksmith/svgs/color-swatch copy.svg +3 -0
  9. data/app/assets/images/marksmith/svgs/color-swatch.svg +3 -0
  10. data/app/assets/images/marksmith/svgs/heading.svg +1 -0
  11. data/app/assets/images/marksmith/svgs/italic.svg +3 -0
  12. data/app/assets/images/marksmith/svgs/link copy.svg +3 -0
  13. data/app/assets/images/marksmith/svgs/link.svg +3 -0
  14. data/app/assets/images/marksmith/svgs/list-bullet.svg +3 -0
  15. data/app/assets/images/marksmith/svgs/list-todo.svg +1 -0
  16. data/app/assets/images/marksmith/svgs/numbered-list.svg +3 -0
  17. data/app/assets/images/marksmith/svgs/photo.svg +3 -0
  18. data/app/assets/images/marksmith/svgs/quote.svg +1 -0
  19. data/app/assets/stylesheets/marksmith/application.css +15 -0
  20. data/app/assets/stylesheets/marksmith.css +517 -0
  21. data/app/controllers/marksmith/application_controller.rb +4 -0
  22. data/app/controllers/marksmith/markdown_previews_controller.rb +8 -0
  23. data/app/frontend/entrypoints/application.css +6 -0
  24. data/app/frontend/entrypoints/application.js +29 -0
  25. data/app/frontend/entrypoints/javascript/controllers/application.js +9 -0
  26. data/app/frontend/entrypoints/javascript/controllers/index.js +7 -0
  27. data/app/frontend/entrypoints/javascript/controllers/marksmith_controller.js +111 -0
  28. data/app/helpers/marksmith/application_helper.rb +4 -0
  29. data/app/helpers/marksmith/helper.rb +21 -0
  30. data/app/jobs/marksmith/application_job.rb +4 -0
  31. data/app/mailers/marksmith/application_mailer.rb +6 -0
  32. data/app/models/marksmith/application_record.rb +5 -0
  33. data/app/models/marksmith/renderer.rb +23 -0
  34. data/app/views/layouts/marksmith/application.html.erb +17 -0
  35. data/app/views/marksmith/markdown_previews/create.turbo_stream.erb +6 -0
  36. data/app/views/marksmith/shared/_editor.html.erb +120 -0
  37. data/app/views/marksmith/shared/_rendered_body.html.erb +3 -0
  38. data/config/locales/marksmith.en.yml +33 -0
  39. data/config/routes.rb +3 -0
  40. data/config/vite.json +16 -0
  41. data/lib/marksmith/engine.rb +25 -0
  42. data/lib/marksmith/version.rb +3 -0
  43. data/lib/marksmith.rb +5 -0
  44. data/lib/tasks/marksmith_tasks.rake +4 -0
  45. metadata +131 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6d144f5f0a3797ce74277c1c58a71ba48519f5c711ea7afd3f1092a8457f41f9
4
+ data.tar.gz: 1ee5710952ff3ab771b81104acc4796b53d12ffee594839c38ef21bce12f0994
5
+ SHA512:
6
+ metadata.gz: b909c1ad8af470ec7729b53bb881a5f40fda4d8822434a55bbbbe0950eba5b49be1b8feb216d5fb4b1122f20db499274e02a672a24d5b2e34cce48aa7401912c
7
+ data.tar.gz: 50779c6beda7286b5623d79a86b7eca7872b33effbc4c0dc07b3cf3815edf4b77ac3d433091c5475a1bde188275a5a54072087172b5ede1ba13eba96b076b72e
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright Adrian Marin
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Marksmith
2
+
3
+ Marksmith a a GitHub-style markdown editor for Rails apps.
4
+
5
+ It supports Active Storage attachments and renders the mardown preview.
6
+
7
+ ## Usage
8
+ How to use my plugin.
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem "marksmith"
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ ```bash
21
+ $ bundle
22
+ ```
23
+
24
+ Or install it yourself as:
25
+ ```bash
26
+ $ bundle add marksmith
27
+ ```
28
+
29
+ Install the NPM package to import the StimulusJS controller.
30
+
31
+ ```bash
32
+ $ yarn add @avo-hq/marksmith
33
+
34
+ # or
35
+
36
+ $ npm install @avo-hq/marksmith
37
+ ```
38
+
39
+
40
+ ## Contributing
41
+ Contribution directions go here.
42
+
43
+ ## License
44
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
45
+
46
+ ## Troubleshooting
47
+
48
+ If you ever get a 431 error from Vite, clear your brower's cache for `localhost` (chrome://settings/content/all?searchSubpage=localhost).
49
+
50
+ ## Releasing
51
+
52
+ Run `bin/release x.y.z`, use `--dry` to skip publishing. This is not idempotent. If releasing fails, take note of where the process left off and continue manually.
53
+
54
+ ### Details
55
+
56
+ In development we use `vite-rails` to compile and reload JS & CSS changes.
57
+
58
+ When releasing we use `rollup` to compile the StimulusJS controller and `@tailwindcss/cli` to compile the CSS.
59
+
60
+ The JS code is pushed to npmjs.org on `@avo-hq/marksmith` and the CSS file is shipped in the gem.
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ require "bundler/setup"
2
+
3
+ APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
4
+ load "rails/tasks/engine.rake"
5
+
6
+ load "rails/tasks/statistics.rake"
7
+
8
+ require "bundler/gem_tasks"
data/app/assets/config/marksmith_manifest.js ADDED
@@ -0,0 +1,2 @@
1
+ //= link_directory ../stylesheets .css
2
+ //= link marksmith.esm.js
data/app/assets/images/marksmith/svgs/bold.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linejoin="round" d="M6.75 3.744h-.753v8.25h7.125a4.125 4.125 0 0 0 0-8.25H6.75Zm0 0v.38m0 16.122h6.747a4.5 4.5 0 0 0 0-9.001h-7.5v9h.753Zm0 0v-.37m0-15.751h6a3.75 3.75 0 1 1 0 7.5h-6m0-7.5v7.5m0 0v8.25m0-8.25h6.375a4.125 4.125 0 0 1 0 8.25H6.75m.747-15.38h4.875a3.375 3.375 0 0 1 0 6.75H7.497v-6.75Zm0 7.5h5.25a3.75 3.75 0 0 1 0 7.5h-5.25v-7.5Z"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/code.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" aria-hidden="true">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M10 20l4-16m4 4l4 4-4 4M6 16l-4-4 4-4"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/color-swatch copy.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" aria-hidden="true">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M7 21a4 4 0 01-4-4V5a2 2 0 012-2h4a2 2 0 012 2v12a4 4 0 01-4 4zm0 0h12a2 2 0 002-2v-4a2 2 0 00-2-2h-2.343M11 7.343l1.657-1.657a2 2 0 012.828 0l2.829 2.829a2 2 0 010 2.828l-8.486 8.485M7 17h.01"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/color-swatch.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" aria-hidden="true">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M7 21a4 4 0 01-4-4V5a2 2 0 012-2h4a2 2 0 012 2v12a4 4 0 01-4 4zm0 0h12a2 2 0 002-2v-4a2 2 0 00-2-2h-2.343M11 7.343l1.657-1.657a2 2 0 012.828 0l2.829 2.829a2 2 0 010 2.828l-8.486 8.485M7 17h.01"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/heading.svg ADDED
@@ -0,0 +1 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-heading"><path d="M6 12h12"/><path d="M6 20V4"/><path d="M18 20V4"/></svg>
data/app/assets/images/marksmith/svgs/italic.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M5.248 20.246H9.05m0 0h3.696m-3.696 0 5.893-16.502m0 0h-3.697m3.697 0h3.803"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/link copy.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/link.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M13.19 8.688a4.5 4.5 0 0 1 1.242 7.244l-4.5 4.5a4.5 4.5 0 0 1-6.364-6.364l1.757-1.757m13.35-.622 1.757-1.757a4.5 4.5 0 0 0-6.364-6.364l-4.5 4.5a4.5 4.5 0 0 0 1.242 7.244"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/list-bullet.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M8.25 6.75h12M8.25 12h12m-12 5.25h12M3.75 6.75h.007v.008H3.75V6.75Zm.375 0a.375.375 0 1 1-.75 0 .375.375 0 0 1 .75 0ZM3.75 12h.007v.008H3.75V12Zm.375 0a.375.375 0 1 1-.75 0 .375.375 0 0 1 .75 0Zm-.375 5.25h.007v.008H3.75v-.008Zm.375 0a.375.375 0 1 1-.75 0 .375.375 0 0 1 .75 0Z"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/list-todo.svg ADDED
@@ -0,0 +1 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-list-todo"><rect x="3" y="5" width="6" height="6" rx="1"/><path d="m3 17 2 2 4-4"/><path d="M13 6h8"/><path d="M13 12h8"/><path d="M13 18h8"/></svg>
data/app/assets/images/marksmith/svgs/numbered-list.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="M8.242 5.992h12m-12 6.003H20.24m-12 5.999h12M4.117 7.495v-3.75H2.99m1.125 3.75H2.99m1.125 0H5.24m-1.92 2.577a1.125 1.125 0 1 1 1.591 1.59l-1.83 1.83h2.16M2.99 15.745h1.125a1.125 1.125 0 0 1 0 2.25H3.74m0-.002h.375a1.125 1.125 0 0 1 0 2.25H2.99"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/photo.svg ADDED
@@ -0,0 +1,3 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon">
2
+ <path stroke-linecap="round" stroke-linejoin="round" d="m2.25 15.75 5.159-5.159a2.25 2.25 0 0 1 3.182 0l5.159 5.159m-1.5-1.5 1.409-1.409a2.25 2.25 0 0 1 3.182 0l2.909 2.909m-18 3.75h16.5a1.5 1.5 0 0 0 1.5-1.5V6a1.5 1.5 0 0 0-1.5-1.5H3.75A1.5 1.5 0 0 0 2.25 6v12a1.5 1.5 0 0 0 1.5 1.5Zm10.5-11.25h.008v.008h-.008V8.25Zm.375 0a.375.375 0 1 1-.75 0 .375.375 0 0 1 .75 0Z"/>
3
+ </svg>
data/app/assets/images/marksmith/svgs/quote.svg ADDED
@@ -0,0 +1 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-text-quote"><path d="M17 6H3"/><path d="M21 12H8"/><path d="M21 18H8"/><path d="M3 12v6"/></svg>
data/app/assets/stylesheets/marksmith/application.css ADDED
@@ -0,0 +1,15 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
10
+ * files in this directory. Styles in this file should be added after the last require_* statement.
11
+ * It is generally better to create a new file per style scope.
12
+ *
13
+ *= require_tree .
14
+ *= require_self
15
+ */