Skip to content

Add new rustdoc web renderer #9347

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

Closed
wants to merge 1 commit into from
Closed
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
3 changes: 3 additions & 0 deletions src/rustdoc_web/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
build/
input/
18 changes: 18 additions & 0 deletions src/rustdoc_web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
rustdoc web frontend
====================

Usage
-----

- clone the repo
- if you don't have npm/node set up, install that first
- run `npm install` to get the dependencies
- place rustdoc_ng output files in input/<version>/<crate>.json where version must match tags on your git repo
- run `./build.sh` to build the input files into a build/ dir

Author
------

Jordi Boggiano - <[email protected]>

Docs design by [Meret Vollenweider](http://meret.com)
7 changes: 7 additions & 0 deletions src/rustdoc_web/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh

rm -rf build/
mkdir build/
node rustdoc.js
cp -rp js build/
./node_modules/.bin/node-sass scss/main.scss build/main.css
24 changes: 24 additions & 0 deletions src/rustdoc_web/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"title": "Rust",
"inputDir": "input/",
"outputDir": "build/",
"faviconUrl": "http://www.rust-lang.org/favicon.ico",
"logoUrl": "http://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
"menu": [
{"name": "Tutorial", "url": "http://doc.rust-lang.org/doc/tutorial.html"},
{"name": "Manual", "url": "http://static.rust-lang.org/doc/rust.html"},
{"name": "Documentation", "url": "%rootPath%"},
{"name": "Releases", "url": "https://github.com/mozilla/rust/wiki/Doc-releases"}
],
"baseSourceUrls": {
"std": "https://github.com/mozilla/rust/blob/%version%/src/",
"extra": "https://github.com/mozilla/rust/blob/%version%/src/"
},
"rustVersion": "master",
"knownCrates": {
"std": {
"url": "http://seld.be/rustdoc/%rustVersion%",
"type": "rustdoc_web"
}
}
}
6 changes: 6 additions & 0 deletions src/rustdoc_web/js/lib/jquery-2.0.3.min.js

Large diffs are not rendered by default.

Loading