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

More themes? #89

Open
quank123wip opened this issue Nov 16, 2024 · 1 comment
Open

More themes? #89

quank123wip opened this issue Nov 16, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@quank123wip
Copy link

mdbook theme is pretty standarized, maybe adding more themes is a cool option. (I'm interested to make one)

@Myriad-Dreamin
Copy link
Owner

In fact we has supported a theme option in CLI, just to update documentation:

shiroa/cli/src/lib.rs

Lines 98 to 103 in 66bd468

/// Specify a theme directory to copy recursively.
///
/// The files will be copied to the `theme/` in the output
/// directory.
#[clap(long)]
pub theme: Option<String>,

You just start to create your theme with following steps:

  1. copy the default theme, themes/mdbook, to other place, and edit the styles and content files inside.
  2. pass the path to the theme to the shiroa CLI.

Note since we haven't stablized any things/styles/interfaces on making a theme, so it may be broken in future (but we'll improve the stability in future).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants