serde-rs.github.io icon indicating copy to clipboard operation
serde-rs.github.io copied to clipboard

Offline docs

Open pickfire opened this issue 6 years ago • 2 comments

Is it possible to have serde.rs docs be part of cargo doc so that it could be viewed offline after users downloaded the serde crate?

This is good for the users who want to check serde examples offline while in an airplane, leveraging the existing cargo doc.

Example https://docs.rs/cargo-crev/0.8.3/cargo_crev/doc/user/getting_started/index.html

pickfire avatar Jul 14 '19 06:07 pickfire

You can get the site offline by running:

$ npm install gitbook-cli -g
$ git clone https://github.com/serde-rs/serde-rs.github.io
$ cd serde-rs.github.io
$ gitbook install
$ gitbook serve

Then the site will be at http://localhost:4000.

dtolnay avatar Jul 14 '19 15:07 dtolnay

@dtolnay Should we document it in the serde.rs? That can easily let others get started for offline usage. But the discoverability for this is not that good as cargo doc, any ideas on how to improve it?

pickfire avatar Jul 15 '19 01:07 pickfire