feat: pull community page content from README via include-markdown - #19
Open
Champbreed wants to merge 1 commit into
Open
feat: pull community page content from README via include-markdown#19Champbreed wants to merge 1 commit into
Champbreed wants to merge 1 commit into
Conversation
Signed-off-by: Simon Essien <champbreed1@gmail.com>
Champbreed
force-pushed
the
feat/community-page-include-markdown
branch
from
August 4, 2026 11:47
990211e to
e56b426
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Adds
mkdocs-include-markdown-pluginsodocs/community.mdpulls its content directly from thecommunityrepo's README at build time, instead of maintaining a manually-copied version.Why
@jpower432 flagged this duplication concern when reviewing #11, and it was later opened as a dedicated issue: oscal compass/community#118. PR oscal-compass/community#167 proposes trimming the README to reduce duplication as this PR takes the complementary approach of having the website pull from the README automatically, so there's no need to keep two copies in sync manually.
Note for reviewers
Since this page now mirrors the README live, trimming the README (as in oscal-compass/community#167) would also remove that content from this page. Worth deciding together whether the README stays the full canonical source, or whether this page's
start=/scope should be adjusted to match a trimmed README.Testing
Verified locally with
mkdocs serve— the page builds and renders the full README content correctly.