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

Collect unparsed comments to rendered object for presenter notes #82

Closed
yhatt opened this issue Oct 9, 2018 · 2 comments
Closed

Collect unparsed comments to rendered object for presenter notes #82

yhatt opened this issue Oct 9, 2018 · 2 comments
Labels
enhancement New feature or request

Comments

@yhatt
Copy link
Member

yhatt commented Oct 9, 2018

To implement presenter notes, we are planning that HTML comments whose not to recognize as YAML object for directives will collect and return in the result object of Marpit.render().

<!-- theme: test-theme -->

# First page

<!-- This HTML comment is not YAML, so it would be collected. -->

---

## Second page

---

### Third page

<!-- It would be collected per pages. -->
<!-- These are expected to use as presenter note. -->
{
  html: '<div class="marpit"><section>...</section></div>',
  css: '.marpit > section { ... }',

  // Collected comments
  comments: [
    ['This HTML comment is not YAML, so it would be collected.'],
    [],
    [
      'It would collect per pages.',
      'These are expected to use as presenter note.',
    ],
  ],
}

At first we had planned to implement this feature in marp-core. But to decide a specification of comment in framework-level is better than implementation at inherited class.

Related to yhatt/marp#30.

@jasonwilliams
Copy link

Hey @yhatt do you know if speaker notes can be styled?
They come out as times new roman and small font and i wonder if its possible to add any styling to them?

@yhatt
Copy link
Member Author

yhatt commented Jul 4, 2020

@jasonwilliams For now, the presenter note is the out of scope for theming provided by framework. Probably we need to update styling in Marp CLI's bespoke template: https://github.com/marp-team/marp-cli/blob/master/src/templates/bespoke/bespoke.scss#L243

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants