Struct mdblog::Mdblog

pub struct Mdblog { /* private fields */ }

blog object

Implementations

impl Mdblog

pub fn new<P: AsRef<Path>>(root: P) -> Result<Mdblog>

create from the root path.

pub fn load_customize_settings(&mut self) -> Result<()>

load blog customize settings.

layered configuration system:

• default settings
• config.toml
• BLOG_ prefix environment variable

pub fn load_posts(&mut self) -> Result<()>

load blog posts.

pub fn init(&mut self) -> Result<()>

init blog directory.

pub fn build(&mut self) -> Result<()>

build the blog html files to build_dir directory.

pub fn serve(&mut self, port: u16) -> Result<()>

serve the blog static files in the build_dir directory.

pub fn rebuild(&mut self) -> Result<()>

rebuild blog

pub fn build_root_dir(&self) -> Result<PathBuf>

blog build directory absolute path.

pub fn theme_root_dir(&self) -> Result<PathBuf>

blog theme root directory absolute path.

pub fn media_root_dir(&self) -> Result<PathBuf>

blog media root directory absolute path.

pub fn post_root_dir(&self) -> Result<PathBuf>

blog posts root directory.

pub fn ignore_patterns(&self) -> Result<Vec<Pattern>>

blog glob ignore patterns.

the patterns are used when :

• mdblog new command, the post path is checked
• mdblog serve command, the modified file path is checked

pub fn create_post(&self, path: &Path, tags: &[String]) -> Result<()>

create a new sample post.

pub fn export_config(&self) -> Result<()>

export blog config.toml file.

pub fn export_media(&self) -> Result<()>

export blog media files.

pub fn export_static(&self) -> Result<()>

export blog static files.

pub fn export_posts(&self) -> Result<()>

export blog posts.

pub fn export_index(&self) -> Result<()>

export blog index page.

pub fn export_tag(&self, tag: &Tag) -> Result<()>

export blog tag index page.

pub fn export_atom(&self) -> Result<()>

export blog atom.xml

pub fn render_post(&self, post: &Post) -> Result<String>

render blog post html.

pub fn render_index(
    &self,
    posts: &[&Rc<Post>],
    prev_name: &str,
    next_name: &str
) -> Result<String>

render index page html.

pub fn render_tag(
    &self,
    title: &str,
    posts: &[Rc<Post>],
    prev_name: &str,
    next_name: &str
) -> Result<String>

render tag pages html.

pub fn list_blog_theme(&self) -> Result<()>

list blog themes.

pub fn create_blog_theme(&self, name: &str) -> Result<()>

create a new blog theme as same as the current blog theme.

pub fn delete_blog_theme(&self, name: &str) -> Result<()>

delete a blog theme.

pub fn set_blog_theme(&mut self, name: &str) -> Result<()>

set blog theme.