actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,078 Commits 9 Branches 89 Tags 16 MiB
Commit Graph

68 Commits

Author SHA1 Message Date
Marcello DeSales 35fd99b05a
📝 🐳 ♻️ add instructions for docker compose 2023-11-23 09:30:00 -08:00
Marcello DeSales 52f007ee7d
📝 ♻️ add docker compose instructions 
$ docker compose build
[+] Building 1.9s (24/24) FINISHED                                                                                                                                   docker-container:mac-linux-builder
 => [mdbook internal] load build definition from Dockerfile                                                                                                                                        0.0s
 => => transferring dockerfile: 2.47kB                                                                                                                                                             0.0s
 => [mdbook internal] load metadata for docker.io/rustlang/rust:nightly-buster-slim                                                                                                                1.4s
 => [mdbook internal] load metadata for docker.io/library/alpine:3.18.4                                                                                                                            1.3s
 => [mdbook auth] library/alpine:pull token for registry-1.docker.io                                                                                                                               0.0s
 => [mdbook auth] rustlang/rust:pull token for registry-1.docker.io                                                                                                                                0.0s
 => [mdbook internal] load .dockerignore                                                                                                                                                           0.0s
 => => transferring context: 2B                                                                                                                                                                    0.0s
 => [mdbook internal] load build context                                                                                                                                                           0.0s
 => => transferring context: 4.94kB                                                                                                                                                                0.0s
 => [mdbook runtime 1/2] FROM docker.io/library/alpine:3.18.4@sha256:eece025e432126ce23f223450a0326fbebde39cdf496a85d8c016293fc851978                                                              0.0s
 => => resolve docker.io/library/alpine:3.18.4@sha256:eece025e432126ce23f223450a0326fbebde39cdf496a85d8c016293fc851978                                                                             0.0s
 => [mdbook builder  1/13] FROM docker.io/rustlang/rust:nightly-buster-slim@sha256:328863752ff0c44a09be7c19d612de90e2a59fc2547496317cc2b01b0c1d1bd0                                                0.0s
 => => resolve docker.io/rustlang/rust:nightly-buster-slim@sha256:328863752ff0c44a09be7c19d612de90e2a59fc2547496317cc2b01b0c1d1bd0                                                                 0.0s
 => CACHED [mdbook builder  2/13] RUN apt-get update && apt-get install -y git                                                                                                                     0.0s
 => CACHED [mdbook builder  3/13] WORKDIR /usr/src/github.com/rust-lang                                                                                                                            0.0s
 => CACHED [mdbook builder  4/13] RUN USER=root cargo new mdBook                                                                                                                                   0.0s
 => CACHED [mdbook builder  5/13] WORKDIR /usr/src/github.com/rust-lang/mdBook                                                                                                                     0.0s
 => CACHED [mdbook builder  6/13] RUN rustup default stable                                                                                                                                        0.0s
 => CACHED [mdbook builder  7/13] RUN rustup target add x86_64-unknown-linux-musl                                                                                                                  0.0s
 => CACHED [mdbook builder  8/13] COPY Cargo.toml Cargo.lock /usr/src/github.com/rust-lang/mdBook                                                                                                  0.0s
 => CACHED [mdbook builder  9/13] COPY examples /usr/src/github.com/rust-lang/mdBook/examples                                                                                                      0.0s
 => CACHED [mdbook builder 10/13] RUN cargo build -vv --config "net.git-fetch-with-cli=true" --target x86_64-unknown-linux-musl --release                                                          0.0s
 => CACHED [mdbook builder 11/13] WORKDIR /usr/src/github.com/rust-lang/mdBook                                                                                                                     0.0s
 => CACHED [mdbook builder 12/13] COPY src /usr/src/github.com/rust-lang/mdBook/src                                                                                                                0.0s
 => CACHED [mdbook builder 13/13] RUN cargo build --locked --bin mdbook --release --target x86_64-unknown-linux-musl                                                                               0.0s
 => CACHED [mdbook runtime 2/2] COPY --from=builder /usr/src/github.com/rust-lang/mdBook/target/x86_64-unknown-linux-musl/release/mdbook /usr/local/bin/mdbook                                     0.0s
 => [mdbook] exporting to docker image format                                                                                                                                                      0.3s
 => => exporting layers                                                                                                                                                                            0.0s
 => => exporting manifest sha256:f4bff2d67ccffb4741203fb90e532154b0e1714343d361ebc1ca682de293fdc9                                                                                                  0.0s
 => => exporting config sha256:d222b963c70cb9ac09fd3ae7c4c51e4605340c6d5a0930cf6b9c85ce145a5b74                                                                                                    0.0s
 => => sending tarball                                                                                                                                                                             0.3s
 => [mdbook mdbook] importing to docker                                                                                                                                                            0.0s
 2023-11-23 08:57:14 -08:00
Marcello DeSales f68dab9f66
📝 ♻️ add docker engine link + fix docker run example 2023-11-23 08:46:42 -08:00
Marcello DeSales d98886415b
📝 README: add container support for users without rust/cargo 2023-02-22 19:21:14 -08:00
Eric Huss f2fba30786 Update documentation 2021-12-19 20:26:37 -08:00
Eric Huss c828002b70 Update some outdated info in the readme. 2021-12-09 17:29:40 -08:00
Wojciech Kępka 981f8695ff Add information about a new backend `mdbook-man` 2021-08-26 17:45:22 +02:00
Maxime BORGES 7af4b1dfe8
[README] Add optional directory parameter for the init command (#1409) 
With the current description of the command, I was expecting to get a directory named with the project name, but the files were created in the current directory.
I Think a more precise description would help first-time users.
 2020-12-23 10:03:31 -08:00
Lucas Zanini 7cb8087469
katex preprocessor 
Added the katex preprocessor to the list of 3rd Party Plugins
 2020-12-03 23:54:12 +01:00
Camelid d1682d27fb
Improve README wording 2020-09-10 13:28:24 -07:00
Camelid efb5bc285d
Fix grammar 
who -> which
 2020-09-04 13:21:37 -07:00
Eric Huss bc23d08fa5
Rename playpen to playground. (#1241) 
looks good
 2020-06-22 16:34:25 +02:00
Eric Huss 6c4c3448e3
Update dependencies. (#1211) 
* Removed the itertools dependency

* Removed an unused feature flag

* Stubbed out a toml_query replacement

* Update dependencies.

* Bump env_logger.

* Use warp instead of iron for http server.

Iron does not appear to be maintained anymore. warp/hyper seems to be
reasonably maintained. Unfortunately this takes a few seconds more
to compile, but shouldn't be too bad.

One benefit is that there is no longer a need for a separate websocket
port, which makes it easier to run multiple servers at once.

* Update pulldown-cmark to 0.7

* Switch from error-chain to anyhow.

* Bump MSRV to 1.39.

* Update elasticlunr-rs.

Co-authored-by: Michael Bryan <michaelfbryan@gmail.com>
 2020-05-20 23:32:00 +02:00
Mathieu David 101063093b
Change CI badge to only push events (#1174) 
I noticed that the CI badge was failing and it seems to be caused by the fact that it reflects the latest build including PRs. This change filters the events to only "push events on the master branch" so the badge stays green even if a PR fails.
 2020-03-23 13:22:12 +01:00
Will Kahn-Greene 8b2659e0f4
Fix typo in README.md 2020-02-06 11:39:37 -05:00
Aleksey Kladov e3717ad47b Add --features to CI recipe (#1103) 2019-11-30 01:10:11 +01:00
Steve Klabnik f79d5d4582 rust-lang-nursery -> rust-lang 
Fixes #1080
 2019-10-29 08:04:16 -05:00
Eric Huss fc4236eaa7 Switch to GitHub Actions. 2019-10-21 10:43:27 -07:00
Carol (Nichols || Goulding) ac1749ff2f Implement a `rustdoc_include` preprocessor (#1003) 
* Allow underscores in the link type name

* Add some tests for include anchors

* Include parts of Rust files and hide the rest

Fixes #618.

* Increase min supported Rust version to 1.35

* Add a test for a behavior of rustdoc_include I want to depend on

At first I thought this was a bug, but then I looked at some use cases
we have in TRPL and decided this was a feature that I'd like to use.
 2019-10-06 00:27:03 +02:00
Carol (Nichols || Goulding) a873d46871 Implement a markdown renderer (#1018) 
Use case: when trying to `mdbook test` a file that has many `include`
directives, and a test fails, the line numbers in the `rustdoc` output
don't match the line numbers in the original markdown file.

Turning on the markdown renderer implemented here lets you see what is
being passed to `rustdoc` by saving the markdown after the preprocessors
have run.

This renderer could be helpful for debugging many preprocessors, but
it's probably not useful in the general case, so it's turned off by
default.
 2019-08-30 12:20:53 +02:00
Carol (Nichols || Goulding) 31e36f85e7
Update specified minimum Rust version and test it in travis 2019-06-20 15:04:55 -04:00
j143-bot d07bd9fed4 Update the `master-docs` link to ../mdBook (#958) 2019-06-20 08:54:38 +02:00
lzutao 8542f7f29d Transition to 2018 edition (#933) 
* Transition to 2018 edition

* Update Travis CI badge in README

* Remove non-idiomatic `extern crate` lines
 2019-05-25 20:50:41 +02:00
Felix Rabe 01fd7a76f0 Typo 2019-04-23 22:11:12 +02:00
Michael Bryan cffc385b0c
Updated the user guide's config section to mention specifying plugin commands 2018-10-20 14:16:07 +08:00
Michael Bryan e73928f933
Mentioned plugins in the README 2018-10-20 14:01:51 +08:00
Philipp Hansch 90bd7207ec
Add minimum required Rust version to README 2018-05-18 09:04:41 +02:00
Michael Bryan d48a27f94f
Updated the appveyor CI image 2018-03-15 09:19:58 +08:00
Bulat Musin 6af77a7792 Update documentation to reflect addition of `clean` subcommand. (#607) 
* update documentation

Update README.md and User Guide to reflect addition of `clean`
subcommand. Do minor spelling fixes too.

* fix grammar in `clean` documentation
 2018-02-18 15:04:04 +08:00
Ofek Lev 31a370d149 fix readme (#606) 2018-02-05 07:11:55 +08:00
Markus Kohlhase b1b8ba4b98 fix(doc): make installation from git work again (#570) 
cargo install --git https://github.com/rust-lang-nursery/mdBook.git
leads to error: multiple packages with binaries found: mdbook, mdbook-wordcount
Fix: append name of binary (`mdbook`).
 2018-01-23 21:07:14 +08:00
Michael Bryan b9ab71b231
Reformatted the README and added a link to the `master` docs (#525) 2018-01-05 11:32:54 +08:00
Anna Liao 5ce05a79be updated links from azerupi to rust-lang-nursery (#489) 2017-11-22 11:35:18 +01:00
Aaron Turon c51e080783
Update broken doc link 2017-11-21 20:32:08 -08:00
Mathieu David 0226da91e4 Fix shield in README 2017-09-11 19:47:39 +02:00
Mathieu David 3b0d2d1238 Add a note about version pinning for people doing automatic deployments of their books 2017-08-01 14:16:39 +02:00
Mathieu David 9447274fa5 Modify the Readme for the new contribution guide 2017-05-16 22:10:24 +02:00
Tshepang Lekhonkhobe 4af107b0ca typos 2017-03-29 16:42:55 +02:00
Jesse Stricker b75243f1f5 Fix some minor typos 2016-12-29 16:25:51 +01:00
Mathieu David a7ae0b99c4 Update README.md 2016-08-13 11:36:28 +02:00
Boris-Chengbiao Zhou 2f43167b75 Add documentation for Serve feature 2016-04-02 05:43:21 +02:00
Mathieu David d0e39f469a Update installation instructions in the README 
Closes #123
 2016-03-22 14:06:32 +01:00
Mathieu David 9e34eccb3e Add windows (AppVeyor) build badge 2016-03-08 01:03:44 +01:00
Eric Bailey 276cd8d490 Update README.md 
Replace two contractions with possessive pronouns: it's => its.
 2016-01-28 00:55:25 -06:00
Mathieu David e958fc8605 update readme 2016-01-13 22:40:30 +01:00
Mathieu David d376b0663a Bumped version to 0.0.4 (after publishing 0.0.3 to crates.io) + updated README to use cargo install for the installation 2015-12-11 22:17:05 +01:00
Mathieu David 259ecfb178 Update readme 2015-09-24 21:07:05 +02:00
Mathieu David bd99a4382f Converted all css to stylus 2015-09-18 22:13:55 +02:00
Mathieu David e377f4702f Preliminary setup for switching from pure css to stylus 2015-09-18 14:46:55 +02:00
Mathieu David 9e2a62f371 travis build icon is now a link to travis in README 2015-08-31 17:16:26 +02:00