Skip to content

Commit 5ce05a7

Browse files
anna-liaobudziq
authored andcommitted
updated links from azerupi to rust-lang-nursery (#489)
1 parent c51e080 commit 5ce05a7

File tree

12 files changed

+33
-34
lines changed

12 files changed

+33
-34
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ Welcome stranger!
55
If you have come here to learn how to contribute to mdBook, we have some tips for you!
66

77
First of all, don't hesitate to ask questions!
8-
Use the [issue tracker](https://github.com/azerupi/mdBook/issues), no question is too simple.
9-
If we don't respond in a couple of days, ping us @azerupi, @steveklabnik, @frewsxcv it might just be that we forgot. :wink:
8+
Use the [issue tracker](https://github.com/rust-lang-nursery/mdBook/issues), no question is too simple.
9+
If we don't respond in a couple of days, ping us @Michael-F-Bryan, @budziq, @steveklabnik, @frewsxcv it might just be that we forgot. :wink:
1010

1111
### Issues to work on
1212

1313
Any issue is up for the grabbing, but if you are starting out, you might be interested in the
14-
[E-Easy issues](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
14+
[E-Easy issues](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
1515
Those are issues that are considered more straightforward for beginners to Rust or the codebase itself.
1616
These issues can be a good launching pad for more involved issues. Easy tasks for a first time contribution
1717
include documentation improvements, new tests, examples, updating dependencies, etc.
1818

1919
If you come from a web development background, you might be interested in issues related to web technologies tagged
20-
[A-JavaScript](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
21-
[A-Style](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
22-
[A-HTML](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-HTML) or
23-
[A-Mobile](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Mobile).
20+
[A-JavaScript](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
21+
[A-Style](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
22+
[A-HTML](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-HTML) or
23+
[A-Mobile](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Mobile).
2424

2525
When you decide you want to work on a specific issue, ping us on that issue so that we can assign it to you.
2626
Again, do not hesitate to ask questions. We will gladly mentor anyone that want to tackle an issue.
@@ -41,7 +41,7 @@ mdBook builds on stable Rust, if you want to build mdBook from source, here are
4141
0. Clone this repository with git.
4242

4343
```
44-
git clone https://github.com/azerupi/mdBook.git
44+
git clone https://github.com/rust-lang-nursery/mdBook.git
4545
```
4646
0. Navigate into the newly created `mdBook` directory
4747
0. Run `cargo build`
@@ -55,7 +55,7 @@ mdBook doesn't use CSS directly but uses [Stylus](http://stylus-lang.com/), a CS
5555

5656
When you want to change the style, it is important to not change the CSS directly because any manual modification to
5757
the CSS files will be overwritten when compiling the stylus files. Instead, you should make your changes directly in the
58-
[stylus files](https://github.com/azerupi/mdBook/tree/master/src/theme/stylus) and regenerate the CSS.
58+
[stylus files](https://github.com/rust-lang-nursery/mdBook/tree/master/src/theme/stylus) and regenerate the CSS.
5959

6060
For this to work, you first need [Node and NPM](https://nodejs.org/en/) installed on your machine.
6161
Then run the following command to install both [stylus](http://stylus-lang.com/) and [nib](https://tj.github.io/nib/), you might need `sudo` to install successfully.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ name = "mdbook"
33
version = "0.0.26"
44
authors = ["Mathieu David <[email protected]>"]
55
description = "create books from markdown files (like Gitbook)"
6-
documentation = "http://azerupi.github.io/mdBook/index.html"
7-
repository = "https://github.com/azerupi/mdBook"
6+
documentation = "http://rust-lang-nursery.github.io/mdBook/index.html"
7+
repository = "https://github.com/rust-lang-nursery/mdBook"
88
keywords = ["book", "gitbook", "rustbook", "markdown"]
99
license = "MPL-2.0"
1010
readme = "README.md"

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<tr>
55
<td><strong>Linux / OS X</strong></td>
66
<td>
7-
<a href="https://travis-ci.org/azerupi/mdBook"><img src="https://travis-ci.org/azerupi/mdBook.svg?branch=master"></a>
7+
<a href="https://travis-ci.org/rust-lang-nursery/mdBook"><img src="https://travis-ci.org/rust-lang-nursery/mdBook.svg?branch=master"></a>
88
</td>
99
</tr>
1010
<tr>
@@ -16,7 +16,7 @@
1616
<tr>
1717
<td colspan="2">
1818
<a href="https://crates.io/crates/mdbook"><img src="https://img.shields.io/crates/v/mdbook.svg"></a>
19-
<a href="LICENSE"><img src="https://img.shields.io/github/license/azerupi/mdBook.svg"></a>
19+
<a href="LICENSE"><img src="https://img.shields.io/github/license/rust-lang-nursery/mdBook.svg"></a>
2020
</td>
2121
</tr>
2222
</table>
@@ -26,14 +26,14 @@ mdBook is a utility to create modern online books from Markdown files.
2626

2727
## What does it look like?
2828

29-
The [**Documentation**](http://rust-lang-nursery.github.io/mdBook/) for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.
29+
The [**User Guide**](https://rust-lang-nursery.github.io/mdBook/) for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.
3030

3131
## Installation
3232

3333
There are multiple ways to install mdBook.
3434

3535
1. **Binaries**
36-
Binaries are available for download [here](https://github.com/azerupi/mdBook/releases). Make sure to put the path to the binary into your `PATH`.
36+
Binaries are available for download [here](https://github.com/rust-lang-nursery/mdBook/releases). Make sure to put the path to the binary into your `PATH`.
3737

3838
2. **From Crates.io**
3939
This requires [Rust and Cargo](https://www.rust-lang.org/) to be installed. Once you have installed Rust, type the following in the terminal:
@@ -55,15 +55,15 @@ There are multiple ways to install mdBook.
5555
The version published to crates.io will ever so slightly be behind the version hosted here on GitHub. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***!
5656

5757
```
58-
cargo install --git https://github.com/azerupi/mdBook.git
58+
cargo install --git https://github.com/rust-lang-nursery/mdBook.git
5959
```
6060
Again, make sure to add the Cargo bin directory to your `PATH`.
6161

6262
4. **For Contributions**
6363
If you want to contribute to mdBook you will have to clone the repository on your local machine:
6464

6565
```
66-
git clone https://github.com/azerupi/mdBook.git
66+
git clone https://github.com/rust-lang-nursery/mdBook.git
6767
```
6868
`cd` into `mdBook/` and run
6969

@@ -79,7 +79,7 @@ There are multiple ways to install mdBook.
7979

8080
mdBook will primarily be used as a command line tool, even though it exposes all its functionality as a Rust crate for integration in other projects.
8181

82-
Here are the main commands you will want to run. For a more exhaustive explanation, check out the [documentation](http://azerupi.github.io/mdBook/).
82+
Here are the main commands you will want to run. For a more exhaustive explanation, check out the [User Guide](http://rust-lang-nursery.github.io/mdBook/).
8383

8484
- `mdbook init`
8585

@@ -95,7 +95,7 @@ Here are the main commands you will want to run. For a more exhaustive explanati
9595
9696
`book` and `src` are both directories. `src` contains the markdown files that will be used to render the output to the `book` directory.
9797
98-
Please, take a look at the [**Documentation**](http://azerupi.github.io/mdBook/cli/init.html) for more information and some neat tricks.
98+
Please, take a look at the [**Documentation**](http://rust-lang-nursery.github.io/mdBook/cli/init.html) for more information and some neat tricks.
9999
100100
- `mdbook build`
101101
@@ -113,13 +113,13 @@ Here are the main commands you will want to run. For a more exhaustive explanati
113113
114114
Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with an easy to use API and more!
115115
116-
See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information.
116+
See the [User Guide](https://rust-lang-nursery.github.io/mdBook/) and the [API docs](https://docs.rs/mdbook/*/mdbook/) for more information.
117117
118118
## Contributions
119119
120120
Contributions are highly appreciated and encouraged! Don't hesitate to participate to discussions in the issues, propose new features and ask for help.
121121
122-
If you are just starting out with Rust, there are a series of issus that are tagged [E-Easy](https://github.com/azerupi/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy) and **we will gladly mentor you** so that you can successfully go through the process of fixing a bug or adding a new feature! Let us know if you need any help.
122+
If you are just starting out with Rust, there are a series of issus that are tagged [E-Easy](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy) and **we will gladly mentor you** so that you can successfully go through the process of fixing a bug or adding a new feature! Let us know if you need any help.
123123
124124
For more info about contributing, check out our [contribution guide](CONTRIBUTING.md) who helps you go through the build and contribution process!
125125

book-example/src/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@
44

55
What you are reading serves as an example of the output of mdBook and at the same time as a high-level documentation.
66

7-
mdBook is free and open source, you can find the source code on [Github](https://github.com/azerupi/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/azerupi/mdBook/issues).
7+
mdBook is free and open source, you can find the source code on [Github](https://github.com/rust-lang-nursery/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/rust-lang-nursery/mdBook/issues).
88

99
## API docs
1010

11-
Alongside this book you can also read the [API docs](mdbook/index.html) generated by Rustdoc if you would like
12-
to use mdBook as a crate or write a new renderer and need a more low-level overview.
11+
Alongside this book you can also read the [API docs](https://docs.rs/mdbook/*/mdbook/) generated by Rustdoc if you would like to use mdBook as a crate or write a new renderer and need a more low-level overview.
1312

1413
## License
1514

book-example/src/cli/cli-tool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Run `mdbook help` in your terminal to verify if it works. Congratulations, you h
2424

2525
### Install Git version
2626

27-
The **[git version](https://github.com/azerupi/mdBook)** contains all the latest bug-fixes and features, that will be released in the next version on **Crates.io**, if you can't wait until the next release. You can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.
27+
The **[git version](https://github.com/rust-lang-nursery/mdBook)** contains all the latest bug-fixes and features, that will be released in the next version on **Crates.io**, if you can't wait until the next release. You can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.
2828

2929
```bash
30-
git clone --depth=1 https://github.com/azerupi/mdBook.git
30+
git clone --depth=1 https://github.com/rust-lang-nursery/mdBook.git
3131
cd mdBook
3232
cargo build --release
3333
```

book-example/src/cli/serve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for you
3737

3838
-----
3939

40-
***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*
40+
***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/rust-lang-nursery/mdBook/issues)*

book-example/src/cli/watch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for you
2323

2424
-----
2525

26-
***note:*** *the `watch` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*
26+
***note:*** *the `watch` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/rust-lang-nursery/mdBook/issues)*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,5 +87,5 @@ In addition to the properties you can access, there are some handlebars helpers
8787
8888
------
8989
90-
*If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/azerupi/mdBook/issues)
90+
*If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/rust-lang-nursery/mdBook/issues)
9191
and I will consider it.*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Will render as
5353
## Improve default theme
5454

5555
If you think the default theme doesn't look quite right for a specific language, or could be improved.
56-
Feel free to [submit a new issue](https://github.com/azerupi/mdBook/issues) explaining what you have in mind and I will take a look at it.
56+
Feel free to [submit a new issue](https://github.com/rust-lang-nursery/mdBook/issues) explaining what you have in mind and I will take a look at it.
5757

5858
You could also create a pull-request with the proposed improvements.
5959

ci/deploy.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ git init
2828
git config user.name "Mathieu David"
2929
git config user.email "[email protected]"
3030

31-
git remote add upstream "https://$GH_TOKEN@github.com/azerupi/mdBook.git"
31+
git remote add upstream "https://$GH_TOKEN@github.com/rust-lang-nursery/mdBook.git"
3232
git fetch upstream
3333
git reset upstream/gh-pages
3434

src/bin/mdbook.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ fn main() {
3636
.after_help("For more information about a specific command, \
3737
try `mdbook <command> --help`\n\
3838
Source code for mdbook available \
39-
at: https://github.com/azerupi/mdBook")
39+
at: https://github.com/rust-lang-nursery/mdBook")
4040
.subcommand(init::make_subcommand())
4141
.subcommand(build::make_subcommand())
4242
.subcommand(test::make_subcommand());

src/utils/fs.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ pub fn file_to_string<P: AsRef<Path>>(path: P) -> Result<String> {
4444
///
4545
/// **note:** it's not very fool-proof, if you find a situation where
4646
/// it doesn't return the correct path.
47-
/// Consider [submitting a new issue](https://github.com/azerupi/mdBook/issues)
48-
/// or a [pull-request](https://github.com/azerupi/mdBook/pulls) to improve it.
47+
/// Consider [submitting a new issue](https://github.com/rust-lang-nursery/mdBook/issues)
48+
/// or a [pull-request](https://github.com/rust-lang-nursery/mdBook/pulls) to improve it.
4949
5050
pub fn path_to_root<P: Into<PathBuf>>(path: P) -> String {
5151
debug!("[fn]: path_to_root");

0 commit comments

Comments
 (0)