Markdown as a default markup

[villanella]

We want to edit Doorstop files as markdown with header instead of yml:

1. to use third-party edit tools. Some editors like VSC, Vim (Vimwiki) support very useful markdown editing features: tables formatting and alignment, custom syntax highlight etc;
2. to edit text without indents. Editing tables in markdown is very uncomfortable when we have to keep indents.

[jacebrowning]

This seems to be a duplicate of #295.

[neerdoc]

@villanella Have you looked at #295? It is probably the best we can do since we do not want to go away from yaml as the file format.

[villanella]

I use this feature "markdown with yaml header" about 1 year in beta-b8 version. I can't upgrade Doorstop to newer versions, because markdown is supported only in beta releases, that aren't stable . Are you planning to support this feature in stable (not beta) release?

[neerdoc]

Always nice to hear from active users!

Yes, it will be supported in stable as it is already included in the development branch.

I've been way to busy with my day job to be able to spend enough time here for the last 2 years, but I've found some time now and is currently working on reaching the 3.0 milestone.

[robtaylor]

What I'm needing is a way to convert yml format items to markdown. My first attempts haven't gone well..
Any clues?

[robtaylor]

actually, this almost did the job:

import doorstop
root=doorstop.Document("./reqs", "./reqs")
for i in root.items:
     i.load()
     i.itemformat="markdown"
     i.save()

Followed by renaming to .md.

Unfortunately I still get an error on loading the documents:

WARNING: REQ: no items
ERROR: no item with UID: REQ001

[robtaylor]

Ah, discovered my mistake: .doorstop.yml should contain:

settings:
    itemformat: markdown

[villanella]

Ah, discovered my mistake: .doorstop.yml should contain:

settings:
    itemformat: markdown

Yes, I know these settings, but current release (not beta) version doesn't support markdown.
And maybe it's not possible to set markdown as default markup for the whole project, without defining this parameter in each document's doorstop.yml.

[robtaylor]

Ah, discovered my mistake: .doorstop.yml should contain:

settings:
    itemformat: markdown

Yes, I know these settings, but current release (not beta) version doesn't support markdown.

We use PDM for all our python projects, and so its easy to add the beta version as a dependency without messing up older projects (pdm run doorstop)

And maybe it's not possible to set markdown as default markup for the whole project, without defining this parameter in each document's .doorstop.yml.

Yeah, I haven't figured out yet if it gets inherited down the tree... I suspect not, and I might throw a patch together if not.

So it sounds like really looking for is export and import from markdown? I can imagine that could get quite tricky. I'm thinking of having non-coders using the nice markdown editor in vscode to edit requirements. I'd be interested to hear your experiences!