Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

info view: markup support #1897

Open
oliver-sanders opened this issue Aug 12, 2024 · 0 comments
Open

info view: markup support #1897

oliver-sanders opened this issue Aug 12, 2024 · 0 comments

Comments

@oliver-sanders
Copy link
Member

Add markup support to metadata in the "Info View".

Users can write metadata for their tasks/workflows. This metadata is displayed in the "Info View". Presently the view displays any metadata as plain text (newlines preserved). It would be nice to enable metadata to be written in a markup language (e.g. markdown or reStructuredText) for better display. Note, Rose has a utility for documenting an app in reStrucutredText so it would be useful to support this as an option.

This would require some mechanism to define the markup language in the workflow. Ideas:

[meta]
    markup = markdown
    description = """
        Foo **bar** [baz](https://cylc.org)!
    """

Or:

[meta]
    description = """markdown
        Foo **bar** [baz](https://cylc.org)!
    """

Or:

[meta]
    description = """
        Assume markdown.
        Foo **bar** [baz](https://cylc.org)!
    """
    _cylc-rose = """rest
        Unless stated otherwise.

         ..code-block::

            [template variables]
            FOO="foo"
    """
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant