Skip to content

Allow Markdow to format text content of device configs#149

Merged
tsterbak merged 4 commits intodevfrom
106-text-format-options-for-device-configs
May 8, 2023
Merged

Allow Markdow to format text content of device configs#149
tsterbak merged 4 commits intodevfrom
106-text-format-options-for-device-configs

Conversation

@tsterbak
Copy link
Member

@tsterbak tsterbak commented May 1, 2023 •
edited
Loading

Addresses #106

You can add emphasis by making text bold (** or __), italic (* or _) or both (*** or ___) now. (asterisk is preferred)

To add paragraphs of lists you need to add two or one empty lines inbetween. Example

- type: call_button
      content: >
        As a first step, you need to unlock the bootloader. A bootloader is the piece of software, that tells your phone
        

        - how to start and run an operating system (like Android). Your device should be turned on.

        - Press 'Confirm and run' to reboot into the bootloader.
      command: adb_reboot_bootloader

@tsterbak tsterbak changed the base branch from main to dev May 1, 2023 15:39
@tsterbak tsterbak added this to the Release Beta 0.4.3 milestone May 1, 2023
@tsterbak
Copy link
Member Author

tsterbak commented May 1, 2023

@MagicLike does that solve your issue?

@MagicLike
Copy link
Member

MagicLike commented May 3, 2023

@MagicLike does that solve your issue?

Partly 😁 - is it also possible to add quotes, code and links?

@tsterbak
Copy link
Member Author

tsterbak commented May 3, 2023

Partly 😁 - is it also possible to add quotes, code and links?

I haven't tested that yet, but code and links should work. Quotes probably not, since > is already used by the yaml standard. But I might be wrong.

@MagicLike
Copy link
Member

MagicLike commented May 6, 2023

Ok, I tested almost every aspect of markdown, the following does not work / not work as it should:

  • Links (clickable, but no link is opened in a browser)
  • Tables (don't render at all)
  • Lists (ordered, unordered, task lists - don't render at all)
  • Strike-through of text (doesn't render at all)
  • Emojis (not coloured, only black borders)

@tsterbak
Copy link
Member Author

tsterbak commented May 7, 2023

Ok, I tested almost every aspect of markdown, the following does not work / not work as it should:

  • Lists should work if you do empty lines like in the example above. I tested that.
  • Yeah tables, strike-through and emojis don't work. But that is also not important for adding more structure to the text of steps.
  • Links I will fix. But that feature should be used really selectively especially to websites that I don't control...

MagicLike
MagicLike reviewed May 7, 2023
View reviewed changes
MagicLike
MagicLike reviewed May 7, 2023
View reviewed changes
Copy link
Member

@MagicLike MagicLike left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - should be fine

@tsterbak tsterbak added the enhancement New feature or request label May 7, 2023
@tsterbak
Copy link
Member Author

tsterbak commented May 7, 2023

LGTM - should be fine

Did lists work for you?

@MagicLike
Copy link
Member

MagicLike commented May 7, 2023

LGTM - should be fine

Did lists work for you?

Yes, if you have a free line after every point

@tsterbak tsterbak merged commit 4d595d3 into dev May 8, 2023
@tsterbak tsterbak deleted the 106-text-format-options-for-device-configs branch May 8, 2023 15:09
@tsterbak tsterbak mentioned this pull request May 8, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MagicLike MagicLike MagicLike left review comments

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

Release Beta 0.4.3

Development

Successfully merging this pull request may close these issues.

2 participants

@tsterbak @MagicLike