Converting to mdbook #53
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in issue#6, this PR tries to add rendering and testing support for the project with mdbook.
To maintain the current structure of the project while playing nicely with mdbook's building system, a dirty script was added into the project. Currently, just type
cargo run render
in the shell, the rendered pages would be ready for publishing in a subdirectory calledbook/
. Check it out on gh-pages.Currently two problems remains:
cargo run test
would fail,Hopefully both problems would be gone after their related PRs being merged into master.
Related: #51 #43