CAN notes are written in a subset of markdown

Although CAN is able to parse and store full markdown (CAN will use remark to process input), to speed up development and avoid thinking through potential pitfalls of full markdown support until later CAN will use a subset of markdown for now.

CAN will initially accept headings, paragraphs, links, bold and italic text. Lists, tables and other features will be introduced later.

Backlinks

• What would be included in a first iteration of CAN?
  • notes are written in a subset of markdown
• CAN should fire a SCRATCHFILE_ERROR event if unsupported syntax is found
  • CAN should parse the scratchfile when it is updated. If CAN hits an error in the scratchfile or finds unsupported syntax (CAN uses a subset of markdown), it should fire a SCRATCHFILE_ERROR event with the error passed as an argument. To allow other parts of the software to respond.
• CAN should parse the scratchfile when it is updated
  • CAN should fire a SCRATCHFILE_PARSED event when the scratchfile is parsed. CAN should fire a SCRATCHFILE_ERROR event if unsupported syntax is found. This could be an error in the parsing step (CAN will use remark to process markdown) or markdown that CAN does not explicitly support - CAN notes are written in a subset of markdown. When a SCRATCHFILE_ERROR is emitted, CAN should inform the user