Deploy README.md to gh-pages branch as website #35
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
tchajed
reviewed
Jul 25, 2024
There was a problem hiding this comment.
Can you rewrite the URLs only in the jekyll build? I think doing a replacement for \(src/.*\.v\) is safe enough. Making the LICENSE links absolute seems fine to me.
Currently this would create dead links for new files in PRs and would make other branches always link to main.
|
@tchajed so can I merge this now? |
|
Looks pretty good, maybe we can add a link in the repo description? https://coq-community.org/coq-tricks/ |
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.
This is to partially address #31. For every push to the
mainbranch,README.mdis deployed asindex.mdto the branchgh-pages, where it will be processed by Jekyll into HTML. To make the deployed HTML usable, the links need to be absolute (since we don't want to deploy.vfiles), so I editREADME.mdto do this.