Skip to content

docs: improve markdownify dependency explanation #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jjroelofs merged 2 commits into from
Oct 18, 2025
Merged

docs: improve markdownify dependency explanation #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73726f6
docs: improve markdownify dependency explanation
Oct 18, 2025
12c2d9f
docs: refocus explanation on general necessity
Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ generating, modifying, and enhancing content directly within your editor.
- CKEditor 5
- PHP 8.1 or higher
- Key module (for secure API key storage)
- Markdownify module (enables internal links to unpublished content)
- Markdownify module (provides markdown versions of Drupal content for AI to access when URLs are included in prompts)
- OpenAI API key

## Installation
Expand Down
7 changes: 4 additions & 3 deletions docs/ckeditor_ai_agent_desc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ <h3 id="module-project--usage-examples">Usage Examples</h3>
<li><strong>Multilingual Content</strong>: Generate content in any language supported by your chosen AI model</li>
</ul>

<h3>Optional Dependencies</h3>
<h3>Dependencies</h3>
<ul>
<li><strong><a href="https://www.drupal.org/project/markdownify">Markdownify module</a></strong> (<code>drupal/markdownify</code>) - Enables internal links to unpublished content for users with appropriate access permissions. When installed, users can reference and link to draft content that they have permission to view, even if it's not published.</li>
</ul>
<li><strong><a href="https://www.drupal.org/project/markdownify">Markdownify module</a></strong> (<code>drupal/markdownify</code>) - Provides markdown versions of Drupal content that the AI can access when URLs are included in prompts. Essential for referencing draft articles, internal documentation, or any unpublished content while respecting user permissions. For example, enables workflows like generating social posts for draft articles.</li>
</ul>