You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

806 lines
28KB

  1. extern crate tera;
  2. extern crate rayon;
  3. extern crate glob;
  4. extern crate walkdir;
  5. extern crate serde;
  6. #[macro_use]
  7. extern crate serde_derive;
  8. extern crate sass_rs;
  9. #[macro_use]
  10. extern crate errors;
  11. extern crate config;
  12. extern crate utils;
  13. extern crate front_matter;
  14. extern crate templates;
  15. extern crate pagination;
  16. extern crate taxonomies;
  17. extern crate content;
  18. #[cfg(test)]
  19. extern crate tempdir;
  20. use std::collections::HashMap;
  21. use std::fs::{remove_dir_all, copy, create_dir_all};
  22. use std::mem;
  23. use std::path::{Path, PathBuf};
  24. use glob::glob;
  25. use tera::{Tera, Context};
  26. use walkdir::WalkDir;
  27. use sass_rs::{Options, OutputStyle, compile_file};
  28. use errors::{Result, ResultExt};
  29. use config::{Config, get_config};
  30. use utils::fs::{create_file, create_directory, ensure_directory_exists};
  31. use utils::templates::{render_template, rewrite_theme_paths};
  32. use content::{Page, Section, populate_previous_and_next_pages, sort_pages};
  33. use templates::{GUTENBERG_TERA, global_fns, render_redirect_template};
  34. use front_matter::{SortBy, InsertAnchor};
  35. use taxonomies::Taxonomy;
  36. use pagination::Paginator;
  37. use rayon::prelude::*;
  38. /// The sitemap only needs links and potentially date so we trim down
  39. /// all pages to only that
  40. #[derive(Debug, Serialize)]
  41. struct SitemapEntry {
  42. permalink: String,
  43. date: Option<String>,
  44. }
  45. impl SitemapEntry {
  46. pub fn new(permalink: String, date: Option<String>) -> SitemapEntry {
  47. SitemapEntry { permalink, date }
  48. }
  49. }
  50. #[derive(Debug)]
  51. pub struct Site {
  52. /// The base path of the gutenberg site
  53. pub base_path: PathBuf,
  54. /// The parsed config for the site
  55. pub config: Config,
  56. pub pages: HashMap<PathBuf, Page>,
  57. pub sections: HashMap<PathBuf, Section>,
  58. pub tera: Tera,
  59. live_reload: bool,
  60. output_path: PathBuf,
  61. pub static_path: PathBuf,
  62. pub tags: Option<Taxonomy>,
  63. pub categories: Option<Taxonomy>,
  64. /// A map of all .md files (section and pages) and their permalink
  65. /// We need that if there are relative links in the content that need to be resolved
  66. pub permalinks: HashMap<String, String>,
  67. }
  68. impl Site {
  69. /// Parse a site at the given path. Defaults to the current dir
  70. /// Passing in a path is only used in tests
  71. pub fn new<P: AsRef<Path>>(path: P, config_file: &str) -> Result<Site> {
  72. let path = path.as_ref();
  73. let mut config = get_config(path, config_file);
  74. let tpl_glob = format!("{}/{}", path.to_string_lossy().replace("\\", "/"), "templates/**/*.*ml");
  75. // Only parsing as we might be extending templates from themes and that would error
  76. // as we haven't loaded them yet
  77. let mut tera = Tera::parse(&tpl_glob).chain_err(|| "Error parsing templates")?;
  78. if let Some(theme) = config.theme.clone() {
  79. // Grab data from the extra section of the theme
  80. config.merge_with_theme(&path.join("themes").join(&theme).join("theme.toml"))?;
  81. // Test that the {templates,static} folder exist for that theme
  82. let theme_path = path.join("themes").join(&theme);
  83. if !theme_path.join("templates").exists() {
  84. bail!("Theme `{}` is missing a templates folder", theme);
  85. }
  86. if !theme_path.join("static").exists() {
  87. bail!("Theme `{}` is missing a static folder", theme);
  88. }
  89. let theme_tpl_glob = format!("{}/{}", path.to_string_lossy().replace("\\", "/"), "themes/**/*.html");
  90. let mut tera_theme = Tera::parse(&theme_tpl_glob).chain_err(|| "Error parsing templates from themes")?;
  91. rewrite_theme_paths(&mut tera_theme, &theme);
  92. tera_theme.build_inheritance_chains()?;
  93. tera.extend(&tera_theme)?;
  94. }
  95. tera.extend(&GUTENBERG_TERA)?;
  96. // the `extend` above already does it but hey
  97. tera.build_inheritance_chains()?;
  98. let site = Site {
  99. base_path: path.to_path_buf(),
  100. config: config,
  101. pages: HashMap::new(),
  102. sections: HashMap::new(),
  103. tera: tera,
  104. live_reload: false,
  105. output_path: path.join("public"),
  106. static_path: path.join("static"),
  107. tags: None,
  108. categories: None,
  109. permalinks: HashMap::new(),
  110. };
  111. Ok(site)
  112. }
  113. /// What the function name says
  114. pub fn enable_live_reload(&mut self) {
  115. self.live_reload = true;
  116. }
  117. /// Get all the orphan (== without section) pages in the site
  118. pub fn get_all_orphan_pages(&self) -> Vec<&Page> {
  119. let mut pages_in_sections = vec![];
  120. let mut orphans = vec![];
  121. for s in self.sections.values() {
  122. pages_in_sections.extend(s.all_pages_path());
  123. }
  124. for page in self.pages.values() {
  125. if !pages_in_sections.contains(&page.file.path) {
  126. orphans.push(page);
  127. }
  128. }
  129. orphans
  130. }
  131. /// Used by tests to change the output path to a tmp dir
  132. #[doc(hidden)]
  133. pub fn set_output_path<P: AsRef<Path>>(&mut self, path: P) {
  134. self.output_path = path.as_ref().to_path_buf();
  135. }
  136. /// Reads all .md files in the `content` directory and create pages/sections
  137. /// out of them
  138. pub fn load(&mut self) -> Result<()> {
  139. let base_path = self.base_path.to_string_lossy().replace("\\", "/");
  140. let content_glob = format!("{}/{}", base_path, "content/**/*.md");
  141. let (section_entries, page_entries): (Vec<_>, Vec<_>) = glob(&content_glob)
  142. .unwrap()
  143. .filter_map(|e| e.ok())
  144. .partition(|entry| entry.as_path().file_name().unwrap() == "_index.md");
  145. let sections = {
  146. let config = &self.config;
  147. section_entries
  148. .into_par_iter()
  149. .filter(|entry| entry.as_path().file_name().unwrap() == "_index.md")
  150. .map(|entry| {
  151. let path = entry.as_path();
  152. Section::from_file(path, config)
  153. })
  154. .collect::<Vec<_>>()
  155. };
  156. let pages = {
  157. let config = &self.config;
  158. page_entries
  159. .into_par_iter()
  160. .filter(|entry| entry.as_path().file_name().unwrap() != "_index.md")
  161. .map(|entry| {
  162. let path = entry.as_path();
  163. Page::from_file(path, config)
  164. })
  165. .collect::<Vec<_>>()
  166. };
  167. // Kinda duplicated code for add_section/add_page but necessary to do it that
  168. // way because of the borrow checker
  169. for section in sections {
  170. let s = section?;
  171. self.add_section(s, false)?;
  172. }
  173. // Insert a default index section if necessary so we don't need to create
  174. // a _index.md to render the index page
  175. let index_path = self.base_path.join("content").join("_index.md");
  176. if !self.sections.contains_key(&index_path) {
  177. let mut index_section = Section::default();
  178. index_section.permalink = self.config.make_permalink("");
  179. index_section.file.parent = self.base_path.join("content");
  180. index_section.file.relative = "_index.md".to_string();
  181. self.sections.insert(index_path, index_section);
  182. }
  183. let mut pages_insert_anchors = HashMap::new();
  184. for page in pages {
  185. let p = page?;
  186. pages_insert_anchors.insert(p.file.path.clone(), self.find_parent_section_insert_anchor(&p.file.parent.clone()));
  187. self.add_page(p, false)?;
  188. }
  189. {
  190. // Another silly thing needed to not borrow &self in parallel and
  191. // make the borrow checker happy
  192. let permalinks = &self.permalinks;
  193. let tera = &self.tera;
  194. let config = &self.config;
  195. self.pages.par_iter_mut()
  196. .map(|(_, page)| {
  197. let insert_anchor = pages_insert_anchors[&page.file.path];
  198. page.render_markdown(permalinks, tera, config, insert_anchor)
  199. })
  200. .fold(|| Ok(()), Result::and)
  201. .reduce(|| Ok(()), Result::and)?;
  202. self.sections.par_iter_mut()
  203. .map(|(_, section)| section.render_markdown(permalinks, tera, config))
  204. .fold(|| Ok(()), Result::and)
  205. .reduce(|| Ok(()), Result::and)?;
  206. }
  207. self.populate_sections();
  208. self.populate_tags_and_categories();
  209. self.register_tera_global_fns();
  210. Ok(())
  211. }
  212. pub fn register_tera_global_fns(&mut self) {
  213. self.tera.register_global_function("get_page", global_fns::make_get_page(&self.pages));
  214. self.tera.register_global_function("get_section", global_fns::make_get_section(&self.sections));
  215. self.tera.register_global_function(
  216. "get_url",
  217. global_fns::make_get_url(self.permalinks.clone(), self.config.clone())
  218. );
  219. }
  220. /// Add a page to the site
  221. /// The `render` parameter is used in the serve command, when rebuilding a page.
  222. /// If `true`, it will also render the markdown for that page
  223. /// Returns the previous page struct if there was one
  224. pub fn add_page(&mut self, page: Page, render: bool) -> Result<Option<Page>> {
  225. let path = page.file.path.clone();
  226. self.permalinks.insert(page.file.relative.clone(), page.permalink.clone());
  227. let prev = self.pages.insert(page.file.path.clone(), page);
  228. if render {
  229. let insert_anchor = self.find_parent_section_insert_anchor(&self.pages[&path].file.parent);
  230. let page = self.pages.get_mut(&path).unwrap();
  231. page.render_markdown(&self.permalinks, &self.tera, &self.config, insert_anchor)?;
  232. }
  233. Ok(prev)
  234. }
  235. /// Add a section to the site
  236. /// The `render` parameter is used in the serve command, when rebuilding a page.
  237. /// If `true`, it will also render the markdown for that page
  238. /// Returns the previous section struct if there was one
  239. pub fn add_section(&mut self, section: Section, render: bool) -> Result<Option<Section>> {
  240. let path = section.file.path.clone();
  241. self.permalinks.insert(section.file.relative.clone(), section.permalink.clone());
  242. let prev = self.sections.insert(section.file.path.clone(), section);
  243. if render {
  244. let section = self.sections.get_mut(&path).unwrap();
  245. section.render_markdown(&self.permalinks, &self.tera, &self.config)?;
  246. }
  247. Ok(prev)
  248. }
  249. /// Finds the insert_anchor for the parent section of the directory at `path`.
  250. /// Defaults to `AnchorInsert::None` if no parent section found
  251. pub fn find_parent_section_insert_anchor(&self, parent_path: &PathBuf) -> InsertAnchor {
  252. match self.sections.get(&parent_path.join("_index.md")) {
  253. Some(s) => s.meta.insert_anchor_links.unwrap(),
  254. None => InsertAnchor::None
  255. }
  256. }
  257. /// Find out the direct subsections of each subsection if there are some
  258. /// as well as the pages for each section
  259. pub fn populate_sections(&mut self) {
  260. let mut grandparent_paths: HashMap<PathBuf, Vec<PathBuf>> = HashMap::new();
  261. for section in self.sections.values_mut() {
  262. if let Some(ref grand_parent) = section.file.grand_parent {
  263. grandparent_paths
  264. .entry(grand_parent.to_path_buf())
  265. .or_insert_with(|| vec![])
  266. .push(section.file.path.clone());
  267. }
  268. // Make sure the pages of a section are empty since we can call that many times on `serve`
  269. section.pages = vec![];
  270. section.ignored_pages = vec![];
  271. }
  272. for page in self.pages.values() {
  273. let parent_section_path = page.file.parent.join("_index.md");
  274. if self.sections.contains_key(&parent_section_path) {
  275. self.sections.get_mut(&parent_section_path).unwrap().pages.push(page.clone());
  276. }
  277. }
  278. self.sort_sections_pages(None);
  279. // TODO: remove this clone
  280. let sections = self.sections.clone();
  281. for section in self.sections.values_mut() {
  282. if let Some(paths) = grandparent_paths.get(&section.file.parent) {
  283. section.subsections = paths
  284. .iter()
  285. .map(|p| sections[p].clone())
  286. .collect::<Vec<_>>();
  287. section.subsections
  288. .sort_by(|a, b| a.meta.weight.unwrap().cmp(&b.meta.weight.unwrap()));
  289. }
  290. }
  291. }
  292. /// Sorts the pages of the section at the given path
  293. /// By default will sort all sections but can be made to only sort a single one by providing a path
  294. pub fn sort_sections_pages(&mut self, only: Option<&Path>) {
  295. for (path, section) in &mut self.sections {
  296. if let Some(p) = only {
  297. if p != path {
  298. continue;
  299. }
  300. }
  301. let pages = mem::replace(&mut section.pages, vec![]);
  302. let (sorted_pages, cannot_be_sorted_pages) = sort_pages(pages, section.meta.sort_by());
  303. section.pages = populate_previous_and_next_pages(&sorted_pages);
  304. section.ignored_pages = cannot_be_sorted_pages;
  305. }
  306. }
  307. /// Find all the tags and categories if it's asked in the config
  308. pub fn populate_tags_and_categories(&mut self) {
  309. let generate_tags_pages = self.config.generate_tags_pages.unwrap();
  310. let generate_categories_pages = self.config.generate_categories_pages.unwrap();
  311. if !generate_tags_pages && !generate_categories_pages {
  312. return;
  313. }
  314. // TODO: can we pass a reference?
  315. let (tags, categories) = Taxonomy::find_tags_and_categories(
  316. &self.config,
  317. self.pages
  318. .values()
  319. .filter(|p| !p.is_draft())
  320. .cloned()
  321. .collect::<Vec<_>>()
  322. .as_slice()
  323. );
  324. if generate_tags_pages {
  325. self.tags = Some(tags);
  326. }
  327. if generate_categories_pages {
  328. self.categories = Some(categories);
  329. }
  330. }
  331. /// Inject live reload script tag if in live reload mode
  332. fn inject_livereload(&self, html: String) -> String {
  333. if self.live_reload {
  334. return html.replace(
  335. "</body>",
  336. r#"<script src="/livereload.js?port=1112&mindelay=10"></script></body>"#
  337. );
  338. }
  339. html
  340. }
  341. /// Copy the file at the given path into the public folder
  342. pub fn copy_static_file<P: AsRef<Path>>(&self, path: P, base_path: &PathBuf) -> Result<()> {
  343. let relative_path = path.as_ref().strip_prefix(base_path).unwrap();
  344. let target_path = self.output_path.join(relative_path);
  345. if let Some(parent_directory) = target_path.parent() {
  346. create_dir_all(parent_directory)?;
  347. }
  348. copy(path.as_ref(), &target_path)?;
  349. Ok(())
  350. }
  351. /// Copy the content of the given folder into the `public` folder
  352. fn copy_static_directory(&self, path: &PathBuf) -> Result<()> {
  353. for entry in WalkDir::new(path).into_iter().filter_map(|e| e.ok()) {
  354. let relative_path = entry.path().strip_prefix(path).unwrap();
  355. let target_path = self.output_path.join(relative_path);
  356. if entry.path().is_dir() {
  357. if !target_path.exists() {
  358. create_directory(&target_path)?;
  359. }
  360. } else {
  361. let entry_fullpath = self.base_path.join(entry.path());
  362. self.copy_static_file(entry_fullpath, path)?;
  363. }
  364. }
  365. Ok(())
  366. }
  367. /// Copy the main `static` folder and the theme `static` folder if a theme is used
  368. pub fn copy_static_directories(&self) -> Result<()> {
  369. // The user files will overwrite the theme files
  370. if let Some(ref theme) = self.config.theme {
  371. self.copy_static_directory(
  372. &self.base_path.join("themes").join(theme).join("static")
  373. )?;
  374. }
  375. // We're fine with missing static folders
  376. if self.static_path.exists() {
  377. self.copy_static_directory(&self.static_path)?;
  378. }
  379. Ok(())
  380. }
  381. /// Deletes the `public` directory if it exists
  382. pub fn clean(&self) -> Result<()> {
  383. if self.output_path.exists() {
  384. // Delete current `public` directory so we can start fresh
  385. remove_dir_all(&self.output_path).chain_err(|| "Couldn't delete `public` directory")?;
  386. }
  387. Ok(())
  388. }
  389. /// Renders a single content page
  390. pub fn render_page(&self, page: &Page) -> Result<()> {
  391. ensure_directory_exists(&self.output_path)?;
  392. // Copy the nesting of the content directory if we have sections for that page
  393. let mut current_path = self.output_path.to_path_buf();
  394. for component in page.path.split('/') {
  395. current_path.push(component);
  396. if !current_path.exists() {
  397. create_directory(&current_path)?;
  398. }
  399. }
  400. // Make sure the folder exists
  401. create_directory(&current_path)?;
  402. // Finally, create a index.html file there with the page rendered
  403. let output = page.render_html(&self.tera, &self.config)?;
  404. create_file(&current_path.join("index.html"), &self.inject_livereload(output))?;
  405. // Copy any asset we found previously into the same directory as the index.html
  406. for asset in &page.assets {
  407. let asset_path = asset.as_path();
  408. copy(&asset_path, &current_path.join(asset_path.file_name().unwrap()))?;
  409. }
  410. Ok(())
  411. }
  412. /// Deletes the `public` directory and builds the site
  413. pub fn build(&self) -> Result<()> {
  414. self.clean()?;
  415. // Render aliases first to allow overwriting
  416. self.render_aliases()?;
  417. self.render_sections()?;
  418. self.render_orphan_pages()?;
  419. self.render_sitemap()?;
  420. if self.config.generate_rss.unwrap() {
  421. self.render_rss_feed()?;
  422. }
  423. self.render_robots()?;
  424. // `render_categories` and `render_tags` will check whether the config allows
  425. // them to render or not
  426. self.render_categories()?;
  427. self.render_tags()?;
  428. if let Some(ref theme) = self.config.theme {
  429. let theme_path = self.base_path.join("themes").join(theme);
  430. if theme_path.join("sass").exists() {
  431. self.compile_sass(&theme_path)?;
  432. }
  433. }
  434. if self.config.compile_sass.unwrap() {
  435. self.compile_sass(&self.base_path)?;
  436. }
  437. self.copy_static_directories()
  438. }
  439. pub fn compile_sass(&self, base_path: &PathBuf) -> Result<()> {
  440. ensure_directory_exists(&self.output_path)?;
  441. let base_path = base_path.to_string_lossy().replace("\\", "/");
  442. let sass_glob = format!("{}/{}", base_path, "sass/**/*.scss");
  443. let files = glob(&sass_glob)
  444. .unwrap()
  445. .filter_map(|e| e.ok())
  446. .filter(|entry| !entry.as_path().file_name().unwrap().to_string_lossy().starts_with('_'))
  447. .collect::<Vec<_>>();
  448. let mut sass_options = Options::default();
  449. sass_options.output_style = OutputStyle::Compressed;
  450. for file in files {
  451. let name = file.as_path().file_stem().unwrap().to_string_lossy();
  452. let css = match compile_file(file.as_path(), sass_options.clone()) {
  453. Ok(c) => c,
  454. Err(e) => bail!(e)
  455. };
  456. create_file(&self.output_path.join(format!("{}.css", name)), &css)?;
  457. }
  458. Ok(())
  459. }
  460. pub fn render_aliases(&self) -> Result<()> {
  461. for page in self.pages.values() {
  462. if let Some(ref aliases) = page.meta.aliases {
  463. for alias in aliases {
  464. let mut output_path = self.output_path.to_path_buf();
  465. for component in alias.split('/') {
  466. output_path.push(&component);
  467. if !output_path.exists() {
  468. create_directory(&output_path)?;
  469. }
  470. }
  471. create_file(&output_path.join("index.html"), &render_redirect_template(&page.permalink, &self.tera)?)?;
  472. }
  473. }
  474. }
  475. Ok(())
  476. }
  477. /// Renders robots.txt
  478. pub fn render_robots(&self) -> Result<()> {
  479. ensure_directory_exists(&self.output_path)?;
  480. create_file(
  481. &self.output_path.join("robots.txt"),
  482. &render_template("robots.txt", &self.tera, &Context::new(), self.config.theme.clone())?
  483. )
  484. }
  485. /// Renders all categories and the single category pages if there are some
  486. pub fn render_categories(&self) -> Result<()> {
  487. if let Some(ref categories) = self.categories {
  488. self.render_taxonomy(categories)?;
  489. }
  490. Ok(())
  491. }
  492. /// Renders all tags and the single tag pages if there are some
  493. pub fn render_tags(&self) -> Result<()> {
  494. if let Some(ref tags) = self.tags {
  495. self.render_taxonomy(tags)?;
  496. }
  497. Ok(())
  498. }
  499. fn render_taxonomy(&self, taxonomy: &Taxonomy) -> Result<()> {
  500. if taxonomy.items.is_empty() {
  501. return Ok(())
  502. }
  503. ensure_directory_exists(&self.output_path)?;
  504. let output_path = self.output_path.join(&taxonomy.get_list_name());
  505. let list_output = taxonomy.render_list(&self.tera, &self.config)?;
  506. create_directory(&output_path)?;
  507. create_file(&output_path.join("index.html"), &self.inject_livereload(list_output))?;
  508. taxonomy
  509. .items
  510. .par_iter()
  511. .map(|item| {
  512. let single_output = taxonomy.render_single_item(item, &self.tera, &self.config)?;
  513. create_directory(&output_path.join(&item.slug))?;
  514. create_file(
  515. &output_path.join(&item.slug).join("index.html"),
  516. &self.inject_livereload(single_output)
  517. )
  518. })
  519. .fold(|| Ok(()), Result::and)
  520. .reduce(|| Ok(()), Result::and)
  521. }
  522. /// What it says on the tin
  523. pub fn render_sitemap(&self) -> Result<()> {
  524. ensure_directory_exists(&self.output_path)?;
  525. let mut context = Context::new();
  526. context.add(
  527. "pages",
  528. &self.pages
  529. .values()
  530. .filter(|p| !p.is_draft())
  531. .map(|p| SitemapEntry::new(p.permalink.clone(), p.meta.date.clone()))
  532. .collect::<Vec<_>>()
  533. );
  534. context.add(
  535. "sections",
  536. &self.sections
  537. .values()
  538. .map(|s| SitemapEntry::new(s.permalink.clone(), None))
  539. .collect::<Vec<_>>()
  540. );
  541. let mut categories = vec![];
  542. if let Some(ref c) = self.categories {
  543. let name = c.get_list_name();
  544. categories.push(SitemapEntry::new(self.config.make_permalink(&name), None));
  545. for item in &c.items {
  546. categories.push(
  547. SitemapEntry::new(self.config.make_permalink(&format!("{}/{}", &name, item.slug)), None),
  548. );
  549. }
  550. }
  551. context.add("categories", &categories);
  552. let mut tags = vec![];
  553. if let Some(ref t) = self.tags {
  554. let name = t.get_list_name();
  555. tags.push(SitemapEntry::new(self.config.make_permalink(&name), None));
  556. for item in &t.items {
  557. tags.push(
  558. SitemapEntry::new(self.config.make_permalink(&format!("{}/{}", &name, item.slug)), None),
  559. );
  560. }
  561. }
  562. context.add("tags", &tags);
  563. context.add("config", &self.config);
  564. let sitemap = &render_template("sitemap.xml", &self.tera, &context, self.config.theme.clone())?;
  565. create_file(&self.output_path.join("sitemap.xml"), sitemap)?;
  566. Ok(())
  567. }
  568. pub fn render_rss_feed(&self) -> Result<()> {
  569. ensure_directory_exists(&self.output_path)?;
  570. let mut context = Context::new();
  571. let pages = self.pages.values()
  572. .filter(|p| p.meta.date.is_some() && !p.is_draft())
  573. .cloned()
  574. .collect::<Vec<Page>>();
  575. // Don't generate a RSS feed if none of the pages has a date
  576. if pages.is_empty() {
  577. return Ok(());
  578. }
  579. let (sorted_pages, _) = sort_pages(pages, SortBy::Date);
  580. context.add("last_build_date", &sorted_pages[0].meta.date);
  581. // limit to the last n elements)
  582. context.add("pages", &sorted_pages.iter().take(self.config.rss_limit.unwrap()).collect::<Vec<_>>());
  583. context.add("config", &self.config);
  584. let rss_feed_url = if self.config.base_url.ends_with('/') {
  585. format!("{}{}", self.config.base_url, "rss.xml")
  586. } else {
  587. format!("{}/{}", self.config.base_url, "rss.xml")
  588. };
  589. context.add("feed_url", &rss_feed_url);
  590. let feed = &render_template("rss.xml", &self.tera, &context, self.config.theme.clone())?;
  591. create_file(&self.output_path.join("rss.xml"), feed)?;
  592. Ok(())
  593. }
  594. /// Renders a single section
  595. pub fn render_section(&self, section: &Section, render_pages: bool) -> Result<()> {
  596. ensure_directory_exists(&self.output_path)?;
  597. let public = self.output_path.clone();
  598. let mut output_path = public.to_path_buf();
  599. for component in &section.file.components {
  600. output_path.push(component);
  601. if !output_path.exists() {
  602. create_directory(&output_path)?;
  603. }
  604. }
  605. if render_pages {
  606. section
  607. .pages
  608. .par_iter()
  609. .map(|p| self.render_page(p))
  610. .fold(|| Ok(()), Result::and)
  611. .reduce(|| Ok(()), Result::and)?;
  612. }
  613. if !section.meta.should_render() {
  614. return Ok(());
  615. }
  616. if let Some(ref redirect_to) = section.meta.redirect_to {
  617. let permalink = self.config.make_permalink(redirect_to);
  618. create_file(&output_path.join("index.html"), &render_redirect_template(&permalink, &self.tera)?)?;
  619. return Ok(());
  620. }
  621. if section.meta.is_paginated() {
  622. self.render_paginated(&output_path, section)?;
  623. } else {
  624. let output = section.render_html(&self.tera, &self.config)?;
  625. create_file(&output_path.join("index.html"), &self.inject_livereload(output))?;
  626. }
  627. Ok(())
  628. }
  629. /// Used only on reload
  630. pub fn render_index(&self) -> Result<()> {
  631. self.render_section(
  632. &self.sections[&self.base_path.join("content").join("_index.md")],
  633. false
  634. )
  635. }
  636. /// Renders all sections
  637. pub fn render_sections(&self) -> Result<()> {
  638. self.sections
  639. .values()
  640. .collect::<Vec<_>>()
  641. .into_par_iter()
  642. .map(|s| self.render_section(s, true))
  643. .fold(|| Ok(()), Result::and)
  644. .reduce(|| Ok(()), Result::and)
  645. }
  646. /// Renders all pages that do not belong to any sections
  647. pub fn render_orphan_pages(&self) -> Result<()> {
  648. ensure_directory_exists(&self.output_path)?;
  649. for page in self.get_all_orphan_pages() {
  650. self.render_page(page)?;
  651. }
  652. Ok(())
  653. }
  654. /// Renders a list of pages when the section/index is wanting pagination.
  655. pub fn render_paginated(&self, output_path: &Path, section: &Section) -> Result<()> {
  656. ensure_directory_exists(&self.output_path)?;
  657. let paginate_path = match section.meta.paginate_path {
  658. Some(ref s) => s.clone(),
  659. None => unreachable!()
  660. };
  661. let paginator = Paginator::new(&section.pages, section);
  662. let folder_path = output_path.join(&paginate_path);
  663. create_directory(&folder_path)?;
  664. paginator
  665. .pagers
  666. .par_iter()
  667. .enumerate()
  668. .map(|(i, pager)| {
  669. let page_path = folder_path.join(&format!("{}", i + 1));
  670. create_directory(&page_path)?;
  671. let output = paginator.render_pager(pager, &self.config, &self.tera)?;
  672. if i > 0 {
  673. create_file(&page_path.join("index.html"), &self.inject_livereload(output))?;
  674. } else {
  675. create_file(&output_path.join("index.html"), &self.inject_livereload(output))?;
  676. create_file(&page_path.join("index.html"), &render_redirect_template(&section.permalink, &self.tera)?)?;
  677. }
  678. Ok(())
  679. })
  680. .fold(|| Ok(()), Result::and)
  681. .reduce(|| Ok(()), Result::and)
  682. }
  683. }