Struct Doc

pub struct Doc {
    pub body: Option<String>,
    pub category: String,
    pub hidden: Option<bool>,
    pub parent_doc: Option<String>,
    pub title: String,
    pub type_: Option<String>,
}

Fields

body: Option<String>

Body content of the page, formatted in ReadMe or Github flavored Markdown. Accepts long page content, for example, greater than 100k characters

category: String

Category ID of the page, which you can get through https://docs.readme.com/developers/reference/categories#getcategory

hidden: Option<bool>

Visibility of the page

parent_doc: Option<String>

For a subpage, specify the parent doc ID, which you can get through https://docs.readme.com/developers/reference/docs#getdoc

title: String

Title of the page

type_: Option<String>

Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the “guides” section). Can be “basic” (most common), “error” (page desribing an API error), or “link” (page that redirects to an external link)

Trait Implementations

impl Debug for Doc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Doc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Doc

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

Formats the value using the given formatter.

impl Serialize for Doc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.