Cheatsheet

See also

MyST reference

Admonition

Note

You should note that the title will be automatically capitalized.

Important

This is an admonition box without a title.

Tip

This is an admonition box without a title.

Warning

This is an admonition box without a title.

Danger

Don't try this at home.

See also

This is a see also section.

Deprecated since version 13: This is an admonition box without a title.

Links

Magic link (bare URLs via linkify Sphinx extension)

https://volto.kitconcept.com

Link to a file in the documentation.

Frontend

Link to an arbitrary target

This requires setting up a label above a heading, then using MyST syntax to create a link to that label.

Click the reference Link to an arbitrary target to jump to the target.

Code

  /**
   * Render method.
   * @method render
   * @returns {string} Markup for the component.
   */
  render() {
    return (
      this.props.messages && (
        <Container className="messages">
          {map(this.props.messages, (message, index) => (
            <Message
              key={message.id}
              value={index}
              onDismiss={this.onDismiss}
              error={message.level === 'error'}
              success={message.level === 'success'}
              warning={message.level === 'warning'}
              info={message.level === 'info'}
              header={message.title}
              content={message.body}
            />
          ))}
        </Container>
      )
    );
  }
);

def somefunction:
"""mydocstring"""
    pass