Build: make docs to preview documentation locally
#365
Labels
Comments
markmandel
added
kind/documentation
Merged
markmandel
added a commit
to markmandel/quilkin
that referenced
this issue
Aug 13, 2021
I had some updates to the documentation I wanted to make, but I wanted to be able to preview the whole documentation set created by `cargo doc` and `mdbook` in the the same directory structure as we have it hosted on Github pages. Also, I saw googleforgames#363. So with some extra components in our build image, and a combination of `cargo watch` and a python dev library that hosts the files, and hot reloads on changes for all documentation, we have a nice local tool for writing and previewing documentation locally! Closes googleforgames#365
markmandel
added a commit
to markmandel/quilkin
that referenced
this issue
Aug 13, 2021
I had some updates to the documentation I wanted to make, but I wanted to be able to preview the whole documentation set created by `cargo doc` and `mdbook` in the the same directory structure as we have it hosted on Github pages. Also, I saw googleforgames#363. So with some extra components in our build image, and a combination of `cargo watch` and a python dev library that hosts the files, and hot reloads on changes for all documentation, we have a nice local tool for writing and previewing documentation locally! Closes googleforgames#365
markmandel
added a commit
to markmandel/quilkin
that referenced
this issue
Aug 13, 2021
I had some updates to the documentation I wanted to make, but I wanted to be able to preview the whole documentation set created by `cargo doc` and `mdbook` in the the same directory structure as we have it hosted on Github pages. Also, I saw googleforgames#363. So with some extra components in our build image, and a combination of `cargo watch` and a python dev library that hosts the files, and hot reloads on changes for all documentation, we have a nice local tool for writing and previewing documentation locally! Closes googleforgames#365
markmandel
added a commit
that referenced
this issue
Aug 13, 2021
I had some updates to the documentation I wanted to make, but I wanted to be able to preview the whole documentation set created by `cargo doc` and `mdbook` in the the same directory structure as we have it hosted on Github pages. Also, I saw #363. So with some extra components in our build image, and a combination of `cargo watch` and a python dev library that hosts the files, and hot reloads on changes for all documentation, we have a nice local tool for writing and previewing documentation locally! Closes #365
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Noted from #363 - it would be good to have a way to locally preview that has the same relative structure that exists on github pages.
A target in our
build/Makefileto power this would be ideal to combine rustdoc and mdbookFor example, on github pages we have:
https://googleforgames.github.io/quilkin/main/book/
https://googleforgames.github.io/quilkin/main/api/quilkin/
Ideally, you would be able to run and preview this locally at:
http://localhost:9000/book/
http://localhost:9000/api/quilkin/
(or pick another random port)
For extra points, if it live reloads on file change, that would also be awesome.
The text was updated successfully, but these errors were encountered: