ferrous-systems / mdslides Goto Github PK

If SUMMARY.md contains this:

# Summary

[Start Here](./start_here.md)

# Rust Fundamentals

## Introduction and History

-   [Overview](./overview.md)

## Compound Types & match

-   [Compound Types](./compound-types.md)

# Applied Rust

## Methods (review)

-   [Method Syntax](./method-syntax.md)

the HTML output should be as follows. Note that the # Summary heading (and all its content) is ignored, because this section is about the slides, rather than being slides themselves.

<h1>Rust Fundamentals</h1>

<h2>Introduction and History</h2>

<ul>
<li><a href="./overview.html">Overview</a></li>
</ul>

<h2>Compound Types & match</h2>

<ul>
<li><a href="./compound-types.html">Compound Types</a></li>
</ul>

<h1>Applied Rust</h1>

<h2>Methods (review)</h2>

<ul>
<li><a href="./method-syntax.html">Method Syntax</a></li>
</ul>

Running --help should report the original repository the binary was built from, which then gives users access to all the dependencies.

Add an optional "--generate-index" argument which will convert <book-path>/src/SUMMARY.md into <output-dir>/index.html, with links to each slide deck.

I feel like we can add some conventional defaults to the two args

• --template
• --output-dir

Use https://github.com/axodotdev/cargo-dist to publish sliders.

The mdbook tool supports code blocks like:

```rust

But also ones like

```rust,editable

You typically use ,editable to get line numbers on the code block (but it also makes the code editable in-line).

The latter kind are not supported by mdslides currently - the language goes though as rust,editable which is not supported by highlight.js.

We could try and patch mdbook to make all code blocks editable by default, or we should patch mdslides to strip ,editable from any code blocks.

Placeholder issue for me - @amanjeev.

Our embedded training book could be used to generate slides but in that training slides need to be succinct and have only a portion of the pages. Look at reveal.js if there is an option to ignore blocks of pages to be converted to slides.

This option will help generate slides from the book without sacrificing the book's detailed nature, which is required in embedded course.

Bring the source code over from material-templates.