Skip to content
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

Offline docs #98

Open
pickfire opened this issue Jul 14, 2019 · 2 comments
Open

Offline docs #98

pickfire opened this issue Jul 14, 2019 · 2 comments

Comments

@pickfire
Copy link

pickfire commented Jul 14, 2019

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
Copy link
Member

dtolnay commented Jul 14, 2019

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants