Struct aurelius::Config

pub struct Config {
    pub initial_markdown: Option<String>,
    pub working_directory: PathBuf,
    pub highlight_theme: String,
    pub external_renderer: Option<(String, Vec<String>)>,
    pub custom_css: Vec<String>,
    pub http_port: u16,
    pub websocket_port: u16,
}

Configuration for the server.

Fields

initial_markdown: Option<String>

The initial markdown that should be displayed when the server has not received markdown yet.

working_directory: PathBuf

The initial working directory for the server. Defaults to the current process' working directory.

Static files will be served relative to this directory.

highlight_theme: String

The highlight.js theme that should be used for syntax highlighting. Defaults to the "github" theme.

external_renderer: Option<(String, Vec<String>)>

A process that should be used to render markdown from stdin on stdout.

custom_css: Vec<String>

Custom CSS styles that should be included in the HTML output. Defaults to GitHub's markdown CSS styles.

http_port: u16

The port that the HTTP server should listen on.

websocket_port: u16

The port that the websocket server should listen on.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.