#138 Render pages from Markdown

Open
opened 3 years ago by paul · 1 comments
paul commented 3 years ago

I did preliminary tests, and having a prebuild job turning markdown to flat xhtml is easy.

However:
None of our pages is written in flat simple XHTML.

  1. due to previous design choices almost every page has a multitude of specialised css classes added to its markup. Markdown is not capable of mapping those in a sensible manner. In most cases those classes do not really need to be assigned manually. Proper automatisation would either require assignment by the xsl processor, or a rewrite of the CSS files. I would prefer the latter.

  2. We usually have a few custom attributes in the xhtml header, like for example the newsdate. Markdown files will have to be preprocessed, to support respective header lines.

ToDo

  • Design pandoc headers for news tags (translatable)
  • check header fields for author, title, translator, newsdate
  • find markdown compatible replacement for most common custom CSS classes
  • how to include the sidebar?
  • header field for body class

(transferred from Pauls Kan-Board)

I did preliminary tests, and having a prebuild job turning markdown to flat xhtml is easy. **However:** None of our pages is written in flat simple XHTML. 1. due to previous design choices almost every page has a multitude of specialised css classes added to its markup. Markdown is not capable of mapping those in a sensible manner. In most cases those classes do not really need to be assigned manually. Proper automatisation would either require assignment by the xsl processor, or a rewrite of the CSS files. I would prefer the latter. 2. We usually have a few custom attributes in the xhtml header, like for example the newsdate. Markdown files will have to be preprocessed, to support respective header lines. #### ToDo * Design pandoc headers for news tags (translatable) * check header fields for author, title, translator, newsdate * find markdown compatible replacement for most common custom CSS classes * how to include the sidebar? * header field for body class (transferred from Pauls Kan-Board)
paul added the
feature-request
label 3 years ago
paul added the
build
label 3 years ago
reinhard removed the due date 0001-01-01 1 year ago
max.mehl commented 1 month ago
Poster
Owner

In the Web Meetup 2021-01-19, we've concluded the following goals and ideas:

  • We want to start with simple pages, so standard news items and newsletters, to not have to overload the system from the start.
  • The goal is not to convert all existing pages to Markdown, but instead allow editors to use Markdown for new content.
  • We said that it makes most sense to convert a Markdown file to XHTML first, and then run this through our build system normally.
  • An open discussion is the choice of the Markdown dialect. We considered the dialects used by Gitea or Hugo to be the optimal choice to be friendly to new editors.
  • We probably need shortcodes for special tags like our modules or figures. Hugo's shortcodes can be an inspiration for the format, but eventually our converter has to understand it.
In the Web Meetup 2021-01-19, we've concluded the following goals and ideas: * We want to start with simple pages, so standard news items and newsletters, to not have to overload the system from the start. * The goal is not to convert all existing pages to Markdown, but instead allow editors to use Markdown for new content. * We said that it makes most sense to convert a Markdown file to XHTML first, and then run this through our build system normally. * An open discussion is the choice of the Markdown dialect. We considered the dialects used by Gitea or Hugo to be the optimal choice to be friendly to new editors. * We probably need shortcodes for special tags like our modules or figures. Hugo's shortcodes can be an inspiration for the format, but eventually our converter has to understand it.
Sign in to join this conversation.
No Milestone
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.