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

IntelliSense for Marp directives #235

Merged
merged 20 commits into from
May 15, 2021
Merged

IntelliSense for Marp directives #235

merged 20 commits into from
May 15, 2021

Conversation

yhatt
Copy link
Member

@yhatt yhatt commented May 14, 2021

Added the basic IntelliSense support for Marp directive. Resolves #158.

Features

  • Hit Ctrl + Space in Markdown front-matter or HTML comments to open IntelliSense for Marp directives. Auto completion items are available only when marked Markdown by marp: true.

    If hitted Ctrl + Space again, user can peek the quick help of Marp directives.

  • A help can peek also when hovered on the recognized directive.

  • Recognized known directives will be highlighted by Marp's brand color. This visualization may help to find meaningless directives. In addition, we have different text style between global directive and local directive.

    The color is defined as marp.directiveKeyForeground and the other VS Code themes can change it (if supported).

Supported directives

Marp for VS Code is depending on all of Marp official toolset. Thus, following directives are all of directives Marp provided.

  • Marp for VS Code
    • marp global directive (Only in the front-matter)
  • Marpit
    • Global directives
      • theme
      • style
      • headingDivider
    • Local directives
      • paginate
      • header
      • footer
      • class
      • backgroundColor
      • backgroundImage
      • backgroundPosition
      • backgroundRepeat
      • backgroundSize
      • color
  • Marp Core
    • size global directive
  • Marp CLI
    • title global directive
    • description global directive
    • url global directive
    • image global directive

@yhatt yhatt merged commit 81fc7a7 into v1 May 15, 2021
@yhatt yhatt deleted the intellisense-for-marp-directives branch May 15, 2021 11:01
@yhatt yhatt mentioned this pull request May 15, 2021
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

Successfully merging this pull request may close these issues.

1 participant