Add a special section for home page

README.md

@@ -123,6 +123,9 @@ which template will be used to render that section.
 Sections will also automatically pick up their subsections, allowing you to make some complex pages layout and
 table of contents.
 
+A special case is the `_index.md` at the root of the `content` directory which represents the homepage. It is only there
+to control pagination and sorting of the homepage.
+
 ### Code highlighting themes
 Code highlighting can be turned on by setting `highlight_code = true` in `config.toml`.
 
@@ -131,6 +134,7 @@ When turned on, all text between backticks will be highlighted, like the example
 ```rust
 let site = Site::new();
 ```
+
 If the name of the language is not given, it will default to plain-text highlighting.
 
 Gutenberg uses Sublime Text themes for syntax highlighting. It comes with the following theme

src/site.rs

@@ -64,6 +64,7 @@ pub struct Site {
     pub config: Config,
     pub pages: HashMap<PathBuf, Page>,
     pub sections: BTreeMap<PathBuf, Section>,
+    pub index: Option<Section>,
     pub tera: Tera,
     live_reload: bool,
     output_path: PathBuf,
@@ -91,6 +92,7 @@ impl Site {
             config: get_config(path, config_file),
             pages: HashMap::new(),
             sections: BTreeMap::new(),
+            index: None,
             tera: tera,
             live_reload: false,
             output_path: path.join("public"),
@@ -117,16 +119,21 @@ impl Site {
     /// Reads all .md files in the `content` directory and create pages/sections
     /// out of them
     pub fn load(&mut self) -> Result<()> {
-        let path = self.base_path.to_string_lossy().replace("\\", "/");
-        let content_glob = format!("{}/{}", path, "content/**/*.md");
+        let base_path = self.base_path.to_string_lossy().replace("\\", "/");
+        let content_glob = format!("{}/{}", base_path, "content/**/*.md");
 
         // TODO: make that parallel, that's the main bottleneck
         // `add_section` and `add_page` can't be used in the parallel version afaik
         for entry in glob(&content_glob).unwrap().filter_map(|e| e.ok()) {
             let path = entry.as_path();
-
             if path.file_name().unwrap() == "_index.md" {
+                // Index section
+                if path.parent().unwrap() == self.base_path.join("content") {
+                    self.index = Some(Section::from_file(path, &self.config)?);
+                } else {
+                    // all the other sections
                     self.add_section(path)?;
+                }
             } else {
                 self.add_page(path)?;
             }

test_site/content/_index.md

@@ -0,0 +1,4 @@
++++
+title = "Home"
+description = ""
++++

tests/site.rs

@@ -22,6 +22,9 @@ fn test_can_parse_site() {
     assert_eq!(site.pages.len(), 10);
     let posts_path = path.join("content").join("posts");
 
+    // We have an index page
+    assert!(site.index.is_some());
+
     // Make sure we remove all the pwd + content from the sections
     let basic = &site.pages[&posts_path.join("simple.md")];
     assert_eq!(basic.components, vec!["posts".to_string()]);