Skip to content

Write markdown pages in the same way as manpages #59

@ollehellman

Description

@ollehellman

Hi,

I added an ugly fix that gives you a

call cli%save_usage_to_markdown('somefile.md')

that is, takes all the command line options and saves them to a markdown page. In a similarly hackish fashion, I joined that with FORD to generate nicely formatted documentation on the fly. The results look something like this:

screen shot 2016-04-02 at 00 10 47

Which I think is quite nice. Write documentation once, and get it everywhere. The drawback is that to make it truly nice it will have to increase complexity of FLAP. One would really like to be able to add things as

call cli%add(switch='--foo',help='some plain text [link](blabla)')

to the help. This will obviously break the actual command line interface and the manpages, but will be useful for the online documentation. Something like

call cli%add(switch='--foo',help='some plain text',mdhelp='md formatted text with a [link](something)')

where the extra optional tag will only get added to the markdown-help.

Personally, I really like this option. Does it sound interesting? I have it implemented and pretty much working, but perhaps not as sophisticated and general as it should be. The reason I ask is that it adds a layer of complexity that might not be desired.

Is this something you might be interested in?

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions