nextcloud / nextcloud/notes

Advertise which flavour of markdown Nextcloud Notes uses

Open
#477 12 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement feature: editor
Dominant language
JavaScript
Stars
738
Forks
162
Avg merge
6h 2m
Merged PRs (30d)
35

Description

Is your feature request related to a problem? Please describe.
Could you please advertise which flavour of markdown you use? It would make migration from other solutions (such as Google Keep via Takeout) much easier combined with pandoc.

Describe the solution you'd like
pandoc supports several version of markdown:

  • gfm (GitHub-Flavored Markdown), or the deprecated and less accurate markdown_github; use * markdown_github only if you need extensions not supported in gfm.
  • markdown (Pandoc’s Markdown)
  • markdown_mmd (MultiMarkdown)
  • markdown_phpextra (PHP Markdown Extra)
  • markdown_strict (original unextended Markdown)

To convert without problems we need to know the flavour!

Describe alternatives you've considered
sed

Additional context
for i in *html; do pandoc -f html -t someMarkdownFlavour "$i" > "$i.md"; done


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by identifying the Markdown parser or conversion configuration used by Nextcloud Notes, then compare its behavior with the Pandoc flavors listed in the issue. Document the exact flavor Notes uses in a user-facing location. Done means users can determine the correct Pandoc input flavor for migration.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.