Add markdown cheat sheet panel to entry form - #19
Merged
Merged
Conversation
Add a right-hand side panel on the new/edit entry page with a quick reference for the markdown syntax supported by render_markdown (headings h1-h3, bold, italic, links, lists, quote, inline/fenced code, tables, divider; no images). The panel is sticky on large screens and hidden below the lg breakpoint where the Preview button still covers the need. Closes #17 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a Markdown quick-reference panel to the entry create/edit form to help users format descriptions using the app’s supported render_markdown feature set (issue #17).
Changes:
- Introduces a new reusable template partial that lists supported Markdown syntax.
- Restructures the entry form page into a two-column layout with a sticky right-side cheat sheet on large screens.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| apps/entries/templates/entries/partials/_markdown_cheatsheet.html | New Markdown cheat sheet partial for supported formatting options. |
| apps/entries/templates/entries/form.html | Updates layout to add a right-side sticky <aside> containing the cheat sheet on lg+ screens. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+48
to
+50
| <dd class="font-mono text-xs text-slate-700 bg-slate-50 rounded px-1.5 py-0.5 whitespace-pre leading-tight">``` | ||
| code | ||
| ```</dd> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a markdown quick-reference as a sticky right-hand side panel on the new/edit entry page, addressing #17.
Changes
entries/partials/_markdown_cheatsheet.htmllisting the syntax actually supported byrender_markdown(headings h1–h3, bold, italic, links, lists, quote, inline/fenced code, tables, divider — no images, since the sanitizer strips<img>).entries/form.htmlrestructured into a two-column layout; the cheat sheet sits in a right<aside>, sticky on large screens and hidden belowlg(the existing "Preview markdown" button still covers small screens).Notes
{% comment %}rather than{# #}for the multi-line developer note (Django{# #}is single-line only and would otherwise render as visible text).Closes #17
🤖 Generated with Claude Code