-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
do not commit generated content to VCS; closes #3713 #4289
Conversation
e0754bb
to
899b3a0
Compare
899b3a0
to
0388875
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This a great addition. I was always a bit weirded out by the auto generation inside version controlled files
This removes `markdown-magic` and replaces its functionality with the built-in data capabilities of 11ty. The TOC, `--help` output, and source files are now all done via global data scripts in `docs/_data`. When building documentation, we will no longer get changes to e.g., `docs/index.md` because of the automatically generated content.
Usage of the words as defined in options will result in a warning, and will not break the build. Also: Eleventy should ignore the historical changelogs in `docs/changelogs`.
b243f24
to
4d7e86e
Compare
I added an official eleventy plugin which detects usages of words like "simply", "obviously", etc., which don't only make the reader feel stupid, but are often straight-up bad writing 😄 It emits warnings at build time and will not break the build. |
I've confirmed the build has passed for real with my eyeballs, so merging |
* do not commit generated content to VCS This removes `markdown-magic` and replaces its functionality with the built-in data capabilities of 11ty. The TOC, `--help` output, and source files are now all done via global data scripts in `docs/_data`. When building documentation, we will no longer get changes to e.g., `docs/index.md` because of the automatically generated content. * add inclusive language plugin to eleventy Usage of the words as defined in options will result in a warning, and will not break the build. Also: Eleventy should ignore the historical changelogs in `docs/changelogs`.
This removes
markdown-magic
and replaces its functionality with the built-in data capabilities of 11ty.The TOC,
--help
output, and source files are now all done via global data scripts indocs/_data
.When building documentation, we will no longer get changes to e.g.,
docs/index.md
because of the automatically generated content.