Skip to content

Commit 1e8d51c

Browse files
committed
fix typos
1 parent 9fb4180 commit 1e8d51c

File tree

9 files changed

+31
-6
lines changed

9 files changed

+31
-6
lines changed

docs/.vitepress/config.js

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ const config = {
1313
image: {
1414
lazyLoading: true,
1515
},
16+
config: (md) => {
17+
md.use(require('markdown-it-task-lists'))
18+
},
1619
},
1720
head: [
1821
[

docs/3.0/fields/markdown.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ betaStatus: Beta
66

77
# Markdown
88

9+
<Image src="/assets/img/fields/markdown/markdown-field.gif" alt="Markdown field" size="800x427" />
10+
911
:::info
1012
In Avo 3.17 we renamed the `markdown` field `easy_mde` and introduced this custom one based on the [Marksmith editor](https://github.com/avo-hq/marksmith).
1113

@@ -14,7 +16,7 @@ Please read the docs on the repo for more information on how it works.
1416

1517
This field is inspired by the wonderful GitHub editor we all love and use.
1618

17-
It supports applying styles to the markup, dropping files in the editor, and using the [Media Library](./media-library).
19+
It supports applying styles to the markup, dropping files in the editor, and using the [Media Library](./../media-library).
1820
The uploaded files will be taken over by Rails and persisted using Active Storage.
1921

2022
```ruby
@@ -29,6 +31,20 @@ gem "marksmith"
2931
```
3032
:::
3133

34+
## Supported features
35+
36+
- [x] ActiveStorage file attachments
37+
- [x] [Media Library](./../media-library) integration
38+
- [x] Preview panel
39+
- [x] [Ready-to-use renderer](https://github.com/avo-hq/marksmith#built-in-preview-renderer)
40+
- [x] Text formatting
41+
- [x] Lists
42+
- [x] Links
43+
- [x] Images
44+
- [x] Tables
45+
- [x] Code blocks
46+
- [x] Headings
47+
3248
## Customize the renderer
3349

3450
There are two places where we parse the markdown into the HTML you see.

docs/3.0/fields/rhino.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ field :body, as: :rhino
1313

1414
Rhino is based on [TipTap](https://tiptap.dev/) which is a powerful and flexible editor.
1515

16-
The Rhino field supports [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) file attachments and seamlessly integrates with the [Media Library](./media-library).
16+
It supports [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) file attachments, [ActionText](https://guides.rubyonrails.org/action_text_overview.html), and seamlessly integrates with the [Media Library](./../media-library).
1717

1818
## Options
1919

docs/3.0/fields/tip_tap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ The `TipTap` field is deprecated in favor of the [Rhino](./rhino) field.
88

99
The Rhino field is a fork of the TipTap editor with some additional features and improvements.
1010

11-
The Rhino field is fully integrated with Avo and provides a seamless experience for managing rich text content using the [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) integration and the [Media Library](./media-library).
11+
The Rhino field is fully integrated with Avo and provides a seamless experience for managing rich text content using the [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) integration and the [Media Library](./../media-library).

docs/3.0/fields/trix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ field :body, as: :trix
1212

1313
The `Trix` field renders a [WYSIWYG Editor](https://trix-editor.org/) and can be associated with a `string` or `text` column in the database. The value stored in the database will be the editor's resulting `HTML` content.
1414

15-
It supports [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) file attachments and seamlessly integrates with the [Media Library](./media-library).
15+
It supports [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html) file attachments, [ActionText](https://guides.rubyonrails.org/action_text_overview.html), and seamlessly integrates with the [Media Library](./../media-library).
1616

1717
<Image src="/assets/img/fields/trix.jpg" width="877" height="193" alt="Trix field" />
1818

docs/3.0/media-library.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you run an asset-intensive, having a place to view all those asses would be g
1010
The Media Library has two goals in mind.
1111

1212
1. Browse and manage all your assets
13-
2. Use it to inject assets in all three of Avo's rich text editors ([trix]('./fields/trix'), [rhino]('./fields/rhino'), and [markdown]('./fields/markdown')).
13+
2. Use it to inject assets in all three of Avo's rich text editors ([trix](./fields/trix), [rhino](./fields/rhino), and [markdown](./fields/markdown)).
1414

1515
:::warning
1616
The Media Library feature is still in alpha and future releases might contain breaking changes so keep an eye out for the upgrade guide.
Loading

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"@heroicons/vue": "^2.0.13",
2020
"lodash": "^4.17.21",
2121
"markdown-it": "^13.0.1",
22-
"markdown-it-container": "^3.0.0"
22+
"markdown-it-container": "^3.0.0",
23+
"markdown-it-task-lists": "^2.1.1"
2324
}
2425
}

yarn.lock

+5
Original file line numberDiff line numberDiff line change
@@ -1057,6 +1057,11 @@ markdown-it-container@^3.0.0:
10571057
resolved "https://registry.yarnpkg.com/markdown-it-container/-/markdown-it-container-3.0.0.tgz#1d19b06040a020f9a827577bb7dbf67aa5de9a5b"
10581058
integrity sha512-y6oKTq4BB9OQuY/KLfk/O3ysFhB3IMYoIWhGJEidXt1NQFocFK2sA2t0NYZAMyMShAGL6x5OPIbrmXPIqaN9rw==
10591059

1060+
markdown-it-task-lists@^2.1.1:
1061+
version "2.1.1"
1062+
resolved "https://registry.yarnpkg.com/markdown-it-task-lists/-/markdown-it-task-lists-2.1.1.tgz#f68f4d2ac2bad5a2c373ba93081a1a6848417088"
1063+
integrity sha512-TxFAc76Jnhb2OUu+n3yz9RMu4CwGfaT788br6HhEDlvWfdeJcLUsxk1Hgw2yJio0OXsxv7pyIPmvECY7bMbluA==
1064+
10601065
markdown-it@^13.0.1:
10611066
version "13.0.1"
10621067
resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-13.0.1.tgz#c6ecc431cacf1a5da531423fc6a42807814af430"

0 commit comments

Comments
 (0)