Search code examples
swiftmarkupswift-playground

Rename default rendered headings like "Example" in Swift Markup language


Raw Markup

enter image description here

Rendered Markup

enter image description here

How do I change the word Example in the "Rendered Markup" to anything I would like?


Solution

  • Custom callouts

    You can make use of a Custom Callout

    /*:
     # Hello, playground!
    
     The print() function in Swift
     
     * callout(Custom Title):
        print("Hello, playground!")
     
    */
    

    Rendered as (using Dusk theme)

    enter image description here


    Additional pre-defined callouts

    If you don't fancy the color of the Custom Callout, there are a few other callouts (in addition to Example) available for use in a playground

    /*:
     # Hello, playground!
    
     The print() function in Swift
     
     * Example:
        print("Hello, playground!")
     
     * Experiment:
        print("Hello, playground!")
     
     * Important:
        print("Hello, playground!")
     
     * Note:
        print("Hello, playground!")
     
    */
    

    enter image description here

    For additional details, see the Markup Formatting Reference - Markup Functionality.