search

serde-rs / serde-rs.github.io

https://serde.rs
Creative Commons Attribution Share Alike 4.0 International
22 stars 96 forks source link

Offline docs #98

Open pickfire opened 5 years ago

pickfire commented 5 years ago

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

dtolnay commented 5 years ago

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.

pickfire commented 5 years ago

@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?