Skip to content

Docs: Snippets #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

codeallthethingz
Copy link
Contributor

@codeallthethingz codeallthethingz commented Feb 8, 2025

This PR adds snippet functionality to the docs using the following format:

!snippet[../snippets/repeating-text.md]

repeating-text.md will be inserted before any other processing happens.

Example here: https://thousandbrainsproject.readme.io/v0.0-snippet-test/docs/osscommunication-improvements

@codeallthethingz codeallthethingz marked this pull request as ready for review February 8, 2025 16:19
@codeallthethingz codeallthethingz added the triaged This issue or pull request was triaged label Feb 8, 2025
@codeallthethingz codeallthethingz removed the request for review from tristanls February 8, 2025 16:20
@thousandbrainsproject thousandbrainsproject deleted a comment from github-actions bot Feb 8, 2025
Copy link
Contributor

@tristanls tristanls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought (non-blocking): I have a concern that a custom and unique documentation system is being slowly developed instead of adopting a product/commodity documentation system like Markdoc or similar.

@codeallthethingz
Copy link
Contributor Author

thought (non-blocking): I have a concern that a custom and unique documentation system is being slowly developed instead of adopting a product/commodity documentation system like Markdoc or similar.

Yeah, it's a good thought. Early on I tried rendering just the HTML and sending that to readme, but it stripped it all out.

@codeallthethingz codeallthethingz merged commit 071c604 into thousandbrainsproject:main Feb 9, 2025
14 checks passed
@codeallthethingz codeallthethingz deleted the snippets branch February 9, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triaged This issue or pull request was triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants