Skip to content

2aronS/md-slides

Repository files navigation

# md-slides

Convert Markdown files into presentation slides

npm install -g md-slides


```javascript
const mdSlides = require('md-slides');

// basic conversion
mdSlides.convert('presentation.md', 'output.html');

// with options
mdSlides.convert('presentation.md', 'output.html', {
  theme: 'dark',
  transition: 'fade',
  aspectRatio: '16:9'
});

notes

Splits on --- horizontal rules by default. Each section becomes a slide.

Supports code blocks with syntax highlighting, lists, images, and basic markdown formatting.

Themes: light, dark, minimal, hacker

Transitions: none, fade, slide, zoom

// programmatic usage
const mdSlides = require('md-slides');
const fs = require('fs');

const markdown = fs.readFileSync('slides.md', 'utf8');

const html = mdSlides.render(markdown, {
  theme: 'hacker',
  transition: 'slide',
  aspectRatio: '16:9',
  controls: true,
  progress: true,
  slideNumbers: true
});

fs.writeFileSync('presentation.html', html);

// custom template
mdSlides.convert('slides.md', 'output.html', {
  template: './custom-template.html',
  css: './custom-styles.css'
});

// CLI usage
// md-slides input.md output.html --theme=dark --transition=fade

MIT

<!-- fix fixme later -->

About

Convert Markdown files into presentation slides

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors