Package readme improvements #214
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
Even if it's not already a None/Content item. Fixes #213
Allows a package readme to simply reference other files (via relative path and optional fragment specifier), like: ``` <!-- include ../../readme.md#content --> <!-- include ../../docs/footer.md --> ``` Where the main project readme could contain a bunch of project-level info, contrib, badges, etc., which you can skip by marking a specific area as t he #content anchor: ``` # My Project // bunch of badges // building/contributing, etc. <~-- #content --> # Usage // now the real stuff we want in a package readme ``` The `footer.md` could contain project sponsors and the like, and also be reused across multiple packages. The includes must be relative (to the including file) file paths, and the fragmnet specifier is optional. If the fragment specifier does not have an "end" anchor in the included file, the file is included from the anchor definition until EOF. The includes are only resolved when the actual .nupkg is created, and via a temp file, to avoid affecting the build's incrementality (which doesn't apply to the .nupkg itself either). Fixes #210
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.