8000 Slide mode problems · Issue #6610 · hedgedoc/hedgedoc · GitHub
[go: up one dir, main page]

Skip to content
8000

Slide mode problems #6610

Open
0 of 1 issue completed
Open

Description

@ErikMichelson

The reveal.js slide mode lacks certain features from HedgeDoc 1.x currently. These should be fixed before the 2.0 release.

Activity

  1. added this to the Version 2.0 milestone on Aug 5, 2026
  2. added
    feature: rendererIssues related to the markdown rendering process and rendering extensions
    on Aug 5, 2026
  3. DerMolly commented on Aug 5, 2026

    @DerMolly
    Member

    We should limit the slideOptions to the amount of options we actually use and support. It should not be possible to set options we don't want the user to change (e.g history).

    A list of sensible slide options would be:

    • controls
    • controlsTutorial
    • controlsBackArrows
    • progress
    • showSlideNumber
    • center
    • loop
    • rtl
    • navigationMode
    • shuffle
    • showNotes
    • autoPlayMedia
    • autoAnimate
    • autoSlide
    • autoSlideStoppable
    • mouseWheel
    • transition
    • transitionSpeed
    • backgroundTransition
  4. DerMolly commented on Aug 5, 2026

    @DerMolly
    Member

    Using reveal.js in HD1 was quite a pain, when you tried to use all of the different options. Many of them relied on HTML Comments which is neither good for readability nor write-ability (Basically everybody copies from the example page).

    Therefore we propose the following new syntax:

    • Fragments #{}
      • Normal #{} will get their index incremented
      • you can also specify the index like this #{42}
      • other extra options like styles can be added like this #{grow} or #{42 grow}
    • inline slide options
      • will be replaced by a special code block slide
      • ```slide
        transition: zoom
        ```
        
      • This code block will change the slide it resides in, but will not the change the default behavior
      • multiple code blocks will be merged, as there can be only one instance of slide options per slide
        • later values will overwrite previous ones
    • notes
      • will be replaced by a special code block note
      •  ```note
         I am a note for a slide
         ```
        
      • Everything in the code block will be given to the speaker mode to be shown as notes for the slide
      • multiple code blocks will be merged (concatenated), as there is only one notes section per slide
  5. ccoenen commented on Aug 8, 2026

    @ccoenen
    Contributor

    would it be possible to see the proposal in action? If that's impractical, could you show how a 3-slide presentation with a couple of options would be written following this proposal?

  6. DerMolly commented on Aug 22, 2026

    @DerMolly
    Member

    Here are some fragment of the slide-example in the old and the proposed new syntax.

    old syntax
    ---
    type: slide
    slideOptions:
      transition: slide
    ---
    
    ## Fragments
    
    `<!-- .element: class="fragment" data-fragment-index="1" -->`
    
    Is the fragment syntax
    
    Hit the next arrow...
    
    ... to step through ...
    
    - a<!-- .element: class="fragment" data-fragment-index="1" -->
    - fragmented<!-- .element: class="fragment" data-fragment-index="2" -->
    - slide.<!-- .element: class="fragment" data-fragment-index="3" -->
    
    Note:
      This slide has fragments which are also stepped through in the notes window.
    
    ---
    
    ## Fragment Styles
    
    There are different types of fragments, like:
    
    grow
    
    shrink
    
    fade-out
    
    fade-up (also down, left and right!)
    
    current-visible
    
    Highlight <span><!-- .element: class="fragment highlight-red" -->red</span> <span><!-- .element: class="fragment highlight-blue" -->blue</span> <span><!-- .element: class="fragment highlight-green"-->green</span>
    
    ---
    
    <!-- .slide: data-transition="zoom" -->
    
    ## Transition Styles
    Different background transitions are available via the transition option. This one's called "zoom".
    
    `<!-- .slide: data-transition="zoom" -->`
    
    Is the transition syntax
    
    You can use:
    
    none/fade/slide/convex/concave/zoom
    
    proposed new syntax
    ---
    type: slide
    slideOptions:
      transition: slide
    ---
    
    ## Fragments
    
    `#{}`
    
    Is the fragment syntax
    
    Hit the next arrow...
    
    ... to step through ...
    
    - a#{1}
    - fragmented#{2}
    - slide.#{3}
    
    ```note
    This slide has fragments which are also stepped through in the notes window.
    ```
    ---
    
    ## Fragment Styles
    
    There are different types of fragments, like:
    
    grow
    
    shrink
    
    fade-out
    
    fade-up (also down, left and right!)
    
    current-visible
    
    Highlight <span>#{highlight red}red</span> <span>#{highlight blue}blue</span> <span>#{highlight green}green</span>
    
    ---
    
    ```slide
    transition: zoom
    ```
    
    ## Transition Styles
    Different background transitions are available via the transition option. This one's called "zoom".
    
    ````
    ```slide
    transition: zoom
    ```
    ````
    
    Is the transition syntax
    
    You can use:
    
    none/fade/slide/convex/concave/zoom
    
    
  7. ccoenen commented on Sep 12, 2026

    @ccoenen
    Contributor

    sorry for the long delay, after looking over this, I think this would be an improvement for sure. I don't know if it conflicts with anything, but nothing comes to mind.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature: rendererIssues related to the markdown rendering process and rendering extensions

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    0