rust-lang / rust-lang/mdBook

Markdown to HTML converter via hbs - single page

Open
#2,435 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-question
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Question

I want to be able co convert a single markdown file and apply it to a single handlebar (hbs) resulting in a single html file. How is this possible using mdbook?

Why am I asking? There are times that I need more css than what exists in mdbook. In steps picocss. The picocss look and feel is amazingly similar to mdbook. If I could use the mdbook tooling (which I am becoming familiar with) to add value around my book (like adding a home page, landing page, etc...), I would consider my self a hero.

Reference: https://www.chuck-stack.org/ (where the homepage is pico and the subsequent pages are mdbook).

Thanks for an amazing product! and thanks for your consideration! Chuck

Version

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files, tests, or entry points are named. Start by reviewing how mdBook currently renders Markdown into a book, then determine whether a single-page Handlebars-to-HTML workflow fits the existing tooling; done would mean producing one HTML page from one Markdown file with custom CSS support.

Written by the indexing model from the issue text.

Assessment

Tech stack
handlebars, markdown, rust
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.