Markdown View

Summary

A view to display a markdown document

Description

Create a view designed to display a markdown document. This view can then be used to display a rendered markdown as a page.

Business Value / Objectives

Provides for being able to create a view from markdown content.

Success Criteria

• Can render markdown doc as page
• Reads and uses front-matter from markdwon doc
• Can display a table of contents for the document
• Can load a markdown doc from remote location via https

Scope

Only that as required to meet the success.

Dependencies

• HTML markdown fetcher

Risks & Mitigations

• Cross Code Scripting
  As the remote markdown doc is not controlled. This could lead to cross-site-scripting if certain html is rendered.
  • Mitigation: Sanitize markdown
  • Control Measures:
    • Prior to beginning to process markdown for rendering, sanitize.
    • Ensure that any html that could allow css, is not on tag whitelist.

Stakeholders / Roles

• Developers

Milestones / Timeline

1. View Creation
2. Remote markdown doc fetching

Linked Features / Stories (Task List)

• Markdown View

• Remote Markdown Document fetching - #234

• Markdown Links Updated.

  • Add "Markdown Document" requirement that for inter-document linking that the links are relative only.
  • Prior to the document being rendered, the relative links must be updated to contain the full-path of the current url. i.e. mdRelativePath=./somedoc.md would be updated to updatelink=nav/path/somedoc.md. same for back ref link, mdRelativePath=../somedoc.md would be updatelink=nav/somedoc.md

Additional Notes / References

No response