Merge pull request #1 from roeegh/master

removed print feature and windows build from action

Author: Robin

.github/workflows/deploy.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest]
     steps:
     - uses: actions/checkout@master
     - name: Install hub

.github/workflows/main.yml

@@ -12,27 +12,14 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        build: [stable, beta, nightly, macos, windows, msrv]
+        build: [stable, macos]
         include:
           - build: stable
             os: ubuntu-latest
             rust: stable
-          - build: beta
-            os: ubuntu-latest
-            rust: beta
-          - build: nightly
-            os: ubuntu-latest
-            rust: nightly
           - build: macos
             os: macos-latest
             rust: stable
-          - build: windows
-            os: windows-latest
-            rust: stable
-          - build: msrv
-            os: ubuntu-latest
-            # sync MSRV with docs: guide/src/guide/installation.md
-            rust: 1.54.0
     steps:
     - uses: actions/checkout@master
     - name: Install Rust

guide/src/format/theme/README.md

@@ -17,7 +17,7 @@ Here are the files you can override:
 - **_css/_** contains the CSS files for styling the book.
     - **_css/chrome.css_** is for UI elements.
     - **_css/general.css_** is the base styles.
-    - **_css/print.css_** is the style for printer output.
+    <!-- - **_css/print.css_** is the style for printer output. -->
     - **_css/variables.css_** contains variables used in other CSS files.
 - **_book.js_** is mostly used to add client side functionality, like hiding /
   un-hiding the sidebar, changing the theme, ...

src/book/init.rs

@@ -134,10 +134,10 @@ impl BookBuilder {
         let mut chrome_css = File::create(cssdir.join("chrome.css"))?;
         chrome_css.write_all(theme::CHROME_CSS)?;
 
-        if html_config.print.enable {
-            let mut print_css = File::create(cssdir.join("print.css"))?;
-            print_css.write_all(theme::PRINT_CSS)?;
-        }
+        // if html_config.print.enable {
+        //     let mut print_css = File::create(cssdir.join("print.css"))?;
+        //     print_css.write_all(theme::PRINT_CSS)?;
+        // }
 
         let mut variables_css = File::create(cssdir.join("variables.css"))?;
         variables_css.write_all(theme::VARIABLES_CSS)?;

src/config.rs

@@ -501,7 +501,7 @@ pub struct HtmlConfig {
     #[serde(alias = "playpen")]
     pub playground: Playground,
     /// Print settings.
-    pub print: Print,
+    // pub print: Print,
     /// Don't render section labels.
     pub no_section_label: bool,
     /// Search settings. If `None`, the default will be used.
@@ -553,7 +553,7 @@ impl Default for HtmlConfig {
             additional_js: Vec::new(),
             fold: Fold::default(),
             playground: Playground::default(),
-            print: Print::default(),
+            // print: Print::default(),
             no_section_label: false,
             search: None,
             git_repository_url: None,
@@ -580,23 +580,23 @@ impl HtmlConfig {
 }
 
 /// Configuration for how to render the print icon, print.html, and print.css.
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
-#[serde(default, rename_all = "kebab-case")]
-pub struct Print {
-    /// Whether print support is enabled.
-    pub enable: bool,
-    /// Insert page breaks between chapters. Default: `true`.
-    pub page_break: bool,
-}
-
-impl Default for Print {
-    fn default() -> Self {
-        Self {
-            enable: true,
-            page_break: true,
-        }
-    }
-}
+// #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+// #[serde(default, rename_all = "kebab-case")]
+// pub struct Print {
+//     /// Whether print support is enabled.
+//     pub enable: bool,
+//     /// Insert page breaks between chapters. Default: `true`.
+//     pub page_break: bool,
+// }
+
+// impl Default for Print {
+//     fn default() -> Self {
+//         Self {
+//             enable: true,
+//             page_break: true,
+//         }
+//     }
+// }
 
 /// Configuration for how to fold chapters of sidebar.
 #[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -1168,23 +1168,23 @@ mod tests {
         Config::from_str(src).unwrap();
     }
 
-    #[test]
-    fn print_config() {
-        let src = r#"
-        [output.html.print]
-        enable = false
-        "#;
-        let got = Config::from_str(src).unwrap();
-        let html_config = got.html_config().unwrap();
-        assert!(!html_config.print.enable);
-        assert!(html_config.print.page_break);
-        let src = r#"
-        [output.html.print]
-        page-break = false
-        "#;
-        let got = Config::from_str(src).unwrap();
-        let html_config = got.html_config().unwrap();
-        assert!(html_config.print.enable);
-        assert!(!html_config.print.page_break);
-    }
+    // #[test]
+    // fn print_config() {
+    //     let src = r#"
+    //     [output.html.print]
+    //     enable = false
+    //     "#;
+    //     let got = Config::from_str(src).unwrap();
+    //     let html_config = got.html_config().unwrap();
+    //     assert!(!html_config.print.enable);
+    //     assert!(html_config.print.page_break);
+    //     let src = r#"
+    //     [output.html.print]
+    //     page-break = false
+    //     "#;
+    //     let got = Config::from_str(src).unwrap();
+    //     let html_config = got.html_config().unwrap();
+    //     assert!(html_config.print.enable);
+    //     assert!(!html_config.print.page_break);
+    // }
 }

src/renderer/html_handlebars/hbs_renderer.rs

@@ -56,13 +56,13 @@ impl HtmlHandlebars {
 
         let fixed_content =
             utils::render_markdown_with_path(&ch.content, ctx.html_config.curly_quotes, Some(path));
-        if !ctx.is_index && ctx.html_config.print.page_break {
-            // Add page break between chapters
-            // See https://developer.mozilla.org/en-US/docs/Web/CSS/break-before and https://developer.mozilla.org/en-US/docs/Web/CSS/page-break-before
-            // Add both two CSS properties because of the compatibility issue
-            print_content
-                .push_str(r#"<div style="break-before: page; page-break-before: always;"></div>"#);
-        }
+        // if !ctx.is_index && ctx.html_config.print.page_break {
+        //     // Add page break between chapters
+        //     // See https://developer.mozilla.org/en-US/docs/Web/CSS/break-before and https://developer.mozilla.org/en-US/docs/Web/CSS/page-break-before
+        //     // Add both two CSS properties because of the compatibility issue
+        //     print_content
+        //         .push_str(r#"<div style="break-before: page; page-break-before: always;"></div>"#);
+        // }
         print_content.push_str(&fixed_content);
 
         // Update the context with data for this file
@@ -72,9 +72,9 @@ impl HtmlHandlebars {
         let filepath = Path::new(&ctx_path).with_extension("html");
 
         // "print.html" is used for the print page.
-        if path == Path::new("print.md") {
-            bail!("{} is reserved for internal use", path.display());
-        };
+        // if path == Path::new("print.md") {
+        //     bail!("{} is reserved for internal use", path.display());
+        // };
 
         let book_title = ctx
             .data
@@ -222,9 +222,9 @@ impl HtmlHandlebars {
         write_file(destination, "book.js", &theme.js)?;
         write_file(destination, "css/general.css", &theme.general_css)?;
         write_file(destination, "css/chrome.css", &theme.chrome_css)?;
-        if html_config.print.enable {
-            write_file(destination, "css/print.css", &theme.print_css)?;
-        }
+        // if html_config.print.enable {
+        //     write_file(destination, "css/print.css", &theme.print_css)?;
+        // }
         write_file(destination, "css/variables.css", &theme.variables_css)?;
         if let Some(contents) = &theme.favicon_png {
             write_file(destination, "favicon.png", contents)?;
@@ -311,22 +311,22 @@ impl HtmlHandlebars {
     }
 
     /// Update the context with data for this file
-    fn configure_print_version(
-        &self,
-        data: &mut serde_json::Map<String, serde_json::Value>,
-        print_content: &str,
-    ) {
-        // Make sure that the Print chapter does not display the title from
-        // the last rendered chapter by removing it from its context
-        data.remove("title");
-        data.insert("is_print".to_owned(), json!(true));
-        data.insert("path".to_owned(), json!("print.md"));
-        data.insert("content".to_owned(), json!(print_content));
-        data.insert(
-            "path_to_root".to_owned(),
-            json!(utils::fs::path_to_root(Path::new("print.md"))),
-        );
-    }
+    // fn configure_print_version(
+    //     &self,
+    //     data: &mut serde_json::Map<String, serde_json::Value>,
+    //     print_content: &str,
+    // ) {
+    //     // Make sure that the Print chapter does not display the title from
+    //     // the last rendered chapter by removing it from its context
+    //     data.remove("title");
+    //     data.insert("is_print".to_owned(), json!(true));
+    //     data.insert("path".to_owned(), json!("print.md"));
+    //     data.insert("content".to_owned(), json!(print_content));
+    //     data.insert(
+    //         "path_to_root".to_owned(),
+    //         json!(utils::fs::path_to_root(Path::new("print.md"))),
+    //     );
+    // }
 
     fn register_hbs_helpers(&self, handlebars: &mut Handlebars<'_>, html_config: &HtmlConfig) {
         handlebars.register_helper(
@@ -550,22 +550,22 @@ impl Renderer for HtmlHandlebars {
         }
 
         // Print version
-        self.configure_print_version(&mut data, &print_content);
-        if let Some(ref title) = ctx.config.book.title {
-            data.insert("title".to_owned(), json!(title));
-        }
+        // self.configure_print_version(&mut data, &print_content);
+        // if let Some(ref title) = ctx.config.book.title {
+        //     data.insert("title".to_owned(), json!(title));
+        // }
 
         // Render the handlebars template with the data
-        if html_config.print.enable {
-            debug!("Render template");
-            let rendered = handlebars.render("index", &data)?;
+        // if html_config.print.enable {
+        //     debug!("Render template");
+        //     let rendered = handlebars.render("index", &data)?;
 
-            let rendered =
-                self.post_process(rendered, &html_config.playground, ctx.config.rust.edition);
+        //     let rendered =
+        //         self.post_process(rendered, &html_config.playground, ctx.config.rust.edition);
 
-            utils::fs::write_file(destination, "print.html", rendered.as_bytes())?;
-            debug!("Creating print.html ✓");
-        }
+        //     utils::fs::write_file(destination, "print.html", rendered.as_bytes())?;
+        //     debug!("Creating print.html ✓");
+        // }
 
         debug!("Copy static files");
         self.copy_static_files(destination, &theme, &html_config)
@@ -689,7 +689,7 @@ fn make_data(
         data.insert("playground_copyable".to_owned(), json!(true));
     }
 
-    data.insert("print_enable".to_owned(), json!(html_config.print.enable));
+    // data.insert("print_enable".to_owned(), json!(html_config.print.enable));
     data.insert("fold_enable".to_owned(), json!(html_config.fold.enable));
     data.insert("fold_level".to_owned(), json!(html_config.fold.level));
 

src/theme/book.js

@@ -464,14 +464,6 @@ function playground_text(playground) {
     });
 })();
 
-(function scrollToTop () {
-    var menuTitle = document.querySelector('.menu-title');
-
-    menuTitle.addEventListener('click', function () {
-        document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
-    });
-})();
-
 (function controllMenu() {
     var menu = document.getElementById('menu-bar');