feat: add readme to denoland #264
Merged
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
WilliamBergamin
added
the
documentation
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.
Summary
This PR aim to allow denoland to display the readme.md from this repository while maintaining a single source of truth for the readme
Testing
Test this out from this branch
Special notes
This change moves the
README.mdcontent tosrc/README.mdand creates a symbolic link betweenREADME.mdandsrc/README.md, this makessrc/README.mdthe source of truth but allows GitHub to properly render theREADME.mdfileI took this approach from the next.js project
Feedback
Requirements
deno task testafter making the changes.