Skip to content

Some love for the rustbook (engine) #26216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 27, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/rustbook/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use term::Term;
use error::{err, CliResult, CommandResult};
use book;
use book::{Book, BookItem};
use css;

use javascript;

use rustdoc;
Expand Down Expand Up @@ -195,9 +195,16 @@ impl Subcommand for Build {
}
try!(fs::create_dir(&tgt));

try!(File::create(&tgt.join("rust-book.css")).and_then(|mut f| {
f.write_all(css::STYLE.as_bytes())
}));
// Copy static files
let css = include_bytes!("static/rustbook.css");
let js = include_bytes!("static/rustbook.js");

let mut css_file = try!(File::create(tgt.join("rust-book.css")));
try!(css_file.write_all(css));

let mut js_file = try!(File::create(tgt.join("rust-book.js")));
try!(js_file.write_all(js));


let mut summary = try!(File::open(&src.join("SUMMARY.md")));
match book::parse_summary(&mut summary, &src) {
Expand Down
63 changes: 1 addition & 62 deletions src/rustbook/javascript.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,67 +11,6 @@
// The rust-book JavaScript in string form.

pub static JAVASCRIPT: &'static str = r#"
<script type="text/javascript">
document.addEventListener("DOMContentLoaded", function(event) {
document.getElementById("toggle-nav").onclick = toggleNav;
function toggleNav() {
var toc = document.getElementById("toc");
var pagewrapper = document.getElementById("page-wrapper");
toggleClass(toc, "mobile-hidden");
toggleClass(pagewrapper, "mobile-hidden");
};

function toggleClass(el, className) {
// from http://youmightnotneedjquery.com/
if (el.classList) {
el.classList.toggle(className);
} else {
var classes = el.className.split(' ');
var existingIndex = classes.indexOf(className);

if (existingIndex >= 0) {
classes.splice(existingIndex, 1);
} else {
classes.push(className);
}

el.className = classes.join(' ');
}
}

// The below code is used to add prev and next navigation links to the bottom
// of each of the sections.
// It works by extracting the current page based on the url and iterates over
// the menu links until it finds the menu item for the current page. We then
// create a copy of the preceding and following menu links and add the
// correct css class and insert them into the bottom of the page.
var toc = document.getElementById('toc').getElementsByTagName('a');
var href = document.location.pathname.split('/').pop();
if (href === 'index.html' || href === '') {
href = 'README.html';
}

for (var i = 0; i < toc.length; i++) {
if (toc[i].attributes['href'].value.split('/').pop() === href) {
var nav = document.createElement('p');
if (i > 0) {
var prevNode = toc[i-1].cloneNode(true);
prevNode.className = 'left';
prevNode.setAttribute('rel', 'prev');
nav.appendChild(prevNode);
}
if (i < toc.length - 1) {
var nextNode = toc[i+1].cloneNode(true);
nextNode.className = 'right';
nextNode.setAttribute('rel', 'next');
nav.appendChild(nextNode);
}
document.getElementById('page').appendChild(nav);
break;
}
}

});
</script>
<script type="text/javascript" src="rust-book.js"></script>
<script type="text/javascript" src="playpen.js"></script>
"#;
1 change: 0 additions & 1 deletion src/rustbook/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ mod build;
mod serve;
mod test;

mod css;
mod javascript;

static EXIT_STATUS: AtomicIsize = ATOMIC_ISIZE_INIT;
Expand Down
73 changes: 50 additions & 23 deletions src/rustbook/css.rs → src/rustbook/static/rustbook.css
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// The rust-book CSS in string form.

pub static STYLE: &'static str = r#"
/**
* Copyright 2013 The Rust Project Developers. See the COPYRIGHT
* file at the top-level directory of this distribution and at
* http://rust-lang.org/COPYRIGHT.
*
* Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
* http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
* <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
* option. This file may not be copied, modified, or distributed
* except according to those terms.
*/

@import url("../rust.css");

body {
max-width:none;
font: 16px/1.4 'Source Serif Pro', Georgia, Times, 'Times New Roman', serif;
line-height: 1.6;
color: #333;
}

h1, h2, h3, h4, h5, h6 {
font-family: 'Open Sans', 'Fira Sans', 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-weight: bold;
color: #333;
}

@media only screen {
Expand All @@ -23,20 +31,21 @@ body {
left: 0px;
top: 0px;
bottom: 0px;
width: 250px;
width: 300px;
overflow-y: auto;
border-right: 1px solid rgba(0, 0, 0, 0.07);
padding: 10px 10px;
font-size: 16px;
background: none repeat scroll 0% 0% #FFF;
font-size: 14px;
box-sizing: border-box;
-webkit-overflow-scrolling: touch;
background-color: #fafafa;
color: #364149;
}

#page-wrapper {
position: absolute;
overflow-y: auto;
left: 260px;
left: 310px;
right: 0px;
top: 0px;
bottom: 0px;
Expand All @@ -47,7 +56,7 @@ body {
}

@media only print {
#toc, #nav {
#toc, #nav, #menu-bar {
display: none;
}
}
Expand Down Expand Up @@ -84,7 +93,7 @@ body {
.section {
list-style: none outside none;
padding-left: 20px;
line-height: 30px;
line-height: 40px;
}

.section li {
Expand All @@ -94,12 +103,17 @@ body {
}

.chapter li a {
color: #000000;
color: #333;
padding: 5px 0;
}

.chapter li a.active {
text-decoration: underline;
font-weight: bold;
color: #008cff;
}

.chapter li a:hover {
color: #008cff;
text-decoration: none;
}

#toggle-nav {
Expand Down Expand Up @@ -138,11 +152,24 @@ body {
padding: 0;
}

pre {
padding: 16px;
overflow: auto;
font-size: 85%;
line-height: 1.45;
background-color: #f7f7f7;
border: 0;
border-radius: 3px;
}

.nav-previous-next {
margin-top: 60px;
}

.left {
float: left;
}

.right {
float: right;
}
"#;
73 changes: 73 additions & 0 deletions src/rustbook/static/rustbook.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.


document.addEventListener("DOMContentLoaded", function(event) {

document.getElementById("toggle-nav").onclick = toggleNav;

function toggleNav() {
var toc = document.getElementById("toc");
var pagewrapper = document.getElementById("page-wrapper");
toggleClass(toc, "mobile-hidden");
toggleClass(pagewrapper, "mobile-hidden");
}

function toggleClass(el, className) {
// from http://youmightnotneedjquery.com/
if (el.classList) {
el.classList.toggle(className);
} else {
var classes = el.className.split(' ');
var existingIndex = classes.indexOf(className);

if (existingIndex >= 0) {
classes.splice(existingIndex, 1);
} else {
classes.push(className);
}

el.className = classes.join(' ');
}
}

// The below code is used to add prev and next navigation links to the bottom
// of each of the sections.
// It works by extracting the current page based on the url and iterates over
// the menu links until it finds the menu item for the current page. We then
// create a copy of the preceding and following menu links and add the
// correct css class and insert them into the bottom of the page.
var toc = document.getElementById('toc').getElementsByTagName('a');
var href = document.location.pathname.split('/').pop();
if (href === 'index.html' || href === '') {
href = 'README.html';
}

for (var i = 0; i < toc.length; i++) {
if (toc[i].attributes.href.value.split('/').pop() === href) {
var nav = document.createElement('p');
if (i > 0) {
var prevNode = toc[i-1].cloneNode(true);
prevNode.className = 'left';
prevNode.setAttribute('rel', 'prev');
nav.appendChild(prevNode);
}
if (i < toc.length - 1) {
var nextNode = toc[i+1].cloneNode(true);
nextNode.className = 'right';
nextNode.setAttribute('rel', 'next');
nav.appendChild(nextNode);
}
document.getElementById('page').appendChild(nav);
break;
}
}

});