Add markdown-powered fields #1749
Merged
Conversation
This file contains 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
Add a form field/widget to edit markdown for text fields. Implement this field initially for the `description` and `selected_bibliography` fields on the `Source` model. Add helper tag `render_markdown` for displaying markdown fields.
dchiller
commented
Feb 3, 2025
lucasmarchd01
approved these changes
Feb 5, 2025
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.
This PR adds machinery to use (edit and display) markdown in text fields. This PR implements this on the
Source.selected_bibliographyandSource.descriptionfields, but the same machinery can be used for other fields (e.g., flat page fields, future landing page fields).The PR includes the following features:
MarkdownWidgetdjango widget that can be used in forms. This widget provides both atextareaediting area and the ability to navigate via tabs to a "preview" area. This preview is generated client side (with themarked.jsdependencies included by way of the widget definition.render_markdowntemplate tag that converts the markdown to html and sanitizes the html on the server side for when fields containing markdown are displayed.MarkdownWidgetand a new classmarkdown-field-displaythat styles the contents of markdown fields (note: in future, these stylings could be expanded to multiple classes that can be used to style fields generated from markdown differently in different contexts).Note: The
render_markdowntag cleans the generated html to remove raw html included in the markdown. Thus, fields displayed with this template tag that have legacy raw html in them will need to be edited before they will display correctly. This editing should occur concurrently with the implementation of this PR on production. I realize that this limits the kinds of things we can do in these fields (we can't use markup alongside markdown), which may present a future problem; on the other hand, we may find that these limits are perfectly fine for our use of these fields.Once this is implemented and relevant fields are edited, we will be able to deal with #1239, #1221, and #1219.
Screenshot of edit tab:
Screenshot of detail view: