Enum NumberingStyle 

#[non_exhaustive]
pub enum NumberingStyle {
    Consecutive,
    Top,
}

The numbering style to be used by the mdbook-numbering preprocessor.

Should be placed under the numbering-style field in the [preprocessor.numbering] section in book.toml.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Consecutive

There should be no more than one top heading (the heading with the highest level) in the chapter, and it should has the same level as the chapter numbering.

For example, if the numbering of the chapter is 1.2.3, the top heading in the chapter should be level 3 (i.e., ### Chapter 1.2.3).

This is the default behavior of mdbook-numbering. And it works well with mdbook-pdf in regard to generating the table of contents.

Top

There should be no more than one top heading (the heading with the highest level) in the chapter, and it should be level 1 (i.e., # Chapter 1.2.3), regardless of the chapter numbering.

This style is more flexible, but may lead to inconsistent heading levels across chapters. And using it you may get a flat table of contents when generating PDF with mdbook-pdf.

By the way, this is how the documentation of mdbook is structured.

Implementations

impl NumberingStyle

pub const fn new() -> Self

Create a new NumberingStyle with default value.

Trait Implementations

impl Clone for NumberingStyle

fn clone(&self) -> NumberingStyle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NumberingStyle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NumberingStyle

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumberingStyle

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NumberingStyle

fn eq(&self, other: &NumberingStyle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NumberingStyle

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NumberingStyle

impl Eq for NumberingStyle

impl StructuralPartialEq for NumberingStyle