Documentation Deployment for code2prompt #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
instead of building mdbook every time just fetch the binary from releases or use a package manager instead. Saves a lot of time and unnecessary cpu usages. |
pwnwriter
reviewed
Jan 12, 2025
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install mdBook | ||
| run: cargo install mdbook |
There was a problem hiding this comment.
Fetch mdbook from releases
curl -sSL -o /tmp/mdbook.tar.gz https://github.com/rust-lang/mdBook/releases/download/v0.4.36/mdbook-v0.4.36-x86_64-unknown-linux-gnu.tar.gz
tar -xf /tmp/mdbook.tar.gz -C /usr/local/bin
mdbook --version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hello @mufeedvh,
I redacted a documentation using mdbook. It can be deployed with a GitHub Action on GitHub Pages.
I already tested this on my fork and the result is already available here.
Changes
gh-pagesbranch.GitHub Pages Setup
Navigate to
Repository Settings -> Pagesand set the source togh-pagesbranch androotdirectory. The documentation should be available there.