Add an entry about the favicon in the docs

Add theme support for favicon

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mdbook"
-version = "0.0.8"
+version = "0.0.9"
 authors = ["Mathieu David <mathieudavid@mathieudavid.org>"]
 description = "create books from markdown files (like Gitbook)"
 documentation = "http://azerupi.github.io/mdBook/index.html"

book-example/src/format/theme/theme.md

@@ -14,6 +14,7 @@ Here are the files you can override:
 - ***book.js*** is mostly used to add client side functionality, like hiding / un-hiding the sidebar, changing the theme, ...
 - ***highlight.js*** is the JavaScript that is used to highlight code snippets, you should not need to modify this.  
 - ***highlight.css*** is the theme used for the code highlighting
+- ***favicon.png*** the favicon that will be used
 
 Generally, when you want to tweak the theme, you don't need to override all the files. If you only need changes in the stylesheet,
 there is no point in overriding all the other files. Because custom files take precedence over built-in ones, they will not get updated with new fixes / features.

src/book/mdbook.rs

@@ -198,6 +198,10 @@ impl MDBook {
         let mut css = try!(File::create(&theme_dir.join("book.css")));
         try!(css.write_all(theme::CSS));
 
+        // favicon.png
+        let mut favicon = try!(File::create(&theme_dir.join("favicon.png")));
+        try!(favicon.write_all(theme::FAVICON));
+
         // book.js
         let mut js = try!(File::create(&theme_dir.join("book.js")));
         try!(js.write_all(theme::JS));

src/renderer/html_handlebars/hbs_renderer.rs

@@ -170,6 +170,12 @@ impl Renderer for HtmlHandlebars {
         };
         try!(css_file.write_all(&theme.css));
 
+        // Favicon
+        let mut favicon_file = if let Ok(f) = File::create(book.get_dest().join("favicon.png")) { f } else {
+            return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create favicon.png")))
+        };
+        try!(favicon_file.write_all(&theme.favicon));
+
         // JQuery local fallback
         let mut jquery = if let Ok(f) = File::create(book.get_dest().join("jquery.js")) { f } else {
             return Err(Box::new(io::Error::new(io::ErrorKind::Other, "Could not create jquery.js")))
@@ -235,6 +241,7 @@ fn make_data(book: &MDBook) -> Result<BTreeMap<String,Json>, Box<Error>> {
     let mut data  = BTreeMap::new();
     data.insert("language".to_owned(), "en".to_json());
     data.insert("title".to_owned(), book.get_title().to_json());
+    data.insert("favicon".to_owned(), "favicon.png".to_json());
 
     let mut chapters = vec![];
 

src/theme/book.css

@@ -253,6 +253,7 @@ table thead td {
 .theme-popup {
   position: relative;
   left: 10px;
+  z-index: 1000;
   -webkit-border-radius: 4px;
   border-radius: 4px;
   font-size: 0.7em;
@@ -263,6 +264,15 @@ table thead td {
   line-height: 25px;
   white-space: nowrap;
 }
+.theme-popup .theme:hover:first-child {
+  border-top-left-radius: inherit;
+  border-top-right-radius: inherit;
+}
+.theme-popup .theme:hover:last-child {
+  border-bottom-left-radius: inherit;
+  border-bottom-right-radius: inherit;
+}
+
 @media only screen and (max-width: 1250px) {
   .nav-chapters {
     display: none;

src/theme/index.hbs

@@ -12,6 +12,8 @@
         <link rel="stylesheet" href="book.css">
         <link href='http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
 
+        <link rel="shortcut icon" href="{{ favicon }}">
+
         <!-- Font Awesome -->
         <link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
 

src/theme/mod.rs

@@ -5,6 +5,7 @@ use std::io::Read;
 
 pub static INDEX: &'static [u8] = include_bytes!("index.hbs");
 pub static CSS: &'static [u8] = include_bytes!("book.css");
+pub static FAVICON: &'static [u8] = include_bytes!("favicon.png");
 pub static JS: &'static [u8] = include_bytes!("book.js");
 pub static HIGHLIGHT_JS: &'static [u8] = include_bytes!("highlight.js");
 pub static TOMORROW_NIGHT_CSS: &'static [u8] = include_bytes!("tomorrow-night.css");
@@ -27,6 +28,7 @@ pub static FONT_AWESOME_OTF: &'static [u8] = include_bytes!("_FontAwesome/fonts/
 pub struct Theme {
     pub index: Vec<u8>,
     pub css: Vec<u8>,
+    pub favicon: Vec<u8>,
     pub js: Vec<u8>,
     pub highlight_css: Vec<u8>,
     pub tomorrow_night_css: Vec<u8>,
@@ -41,6 +43,7 @@ impl Theme {
         let mut theme = Theme {
             index: INDEX.to_owned(),
             css: CSS.to_owned(),
+            favicon: FAVICON.to_owned(),
             js: JS.to_owned(),
             highlight_css: HIGHLIGHT_CSS.to_owned(),
             tomorrow_night_css: TOMORROW_NIGHT_CSS.to_owned(),
@@ -79,6 +82,12 @@ impl Theme {
             let _ = f.read_to_end(&mut theme.css);
         }
 
+        // favicon.png
+        if let Ok(mut f) = File::open(&src.join("favicon.png")) {
+            theme.favicon.clear();
+            let _ = f.read_to_end(&mut theme.favicon);
+        }
+
         // highlight.js
         if let Ok(mut f) = File::open(&src.join("highlight.js")) {
             theme.highlight_js.clear();

src/theme/stylus/theme-popup.styl

@@ -2,6 +2,8 @@
     position: relative
     left: 10px
 
+    z-index: 1000;
+    
     border-radius: 4px
     font-size: 0.7em