Skip to content
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

chore: Write read me for the Markdoc config. #7989

Merged
merged 8 commits into from
Aug 25, 2023
Merged

Conversation

louiss0
Copy link
Contributor

@louiss0 louiss0 commented Aug 8, 2023

Changes

  • This adds a guide to the Markdoc Docs on how to make Markdoc work with the language server.

Testing

I looked at a preview inside of Markdown to see if things were good.

Docs

The change is the change to a read-me file I was not told to change the docs at all.

Context

I was requested by Ben to change the read-me of the markdoc folder here

With this change people will be able to use Markdoc in VSCode with it's Language Server.

@louiss0 louiss0 requested a review from a team as a code owner August 8, 2023 00:53
@changeset-bot
Copy link

changeset-bot bot commented Aug 8, 2023

⚠️ No Changeset found

Latest commit: c6cb1f1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Aug 8, 2023
Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

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

hey @louiss0, thanks for your PR! I left a couple of changes for you to review!

packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
louiss0 and others added 5 commits August 18, 2023 10:22
fix: Make sentences more explicit

Co-authored-by: Elian ☕️ <hello@elian.codes>
fix: Make config sentence clearer

Co-authored-by: Elian ☕️ <hello@elian.codes>
fix: Change placing for sentences for markdown

Co-authored-by: Elian ☕️ <hello@elian.codes>
fix: Use one sentence instead of a list

Co-authored-by: Elian ☕️ <hello@elian.codes>
fix: Remove all words that are "the" from sentences that talk about schema config

Co-authored-by: Elian ☕️ <hello@elian.codes>
@louiss0
Copy link
Contributor Author

louiss0 commented Aug 18, 2023

hey @louiss0, thanks for your PR! I left a couple of changes for you to review!

I decided to commit all of your suggestions. Nice ones.

@ElianCodes
Copy link
Member

@bholmesdev, can you take one final look on this one, to make sure it matches?

Copy link
Contributor

@bholmesdev bholmesdev left a comment

Choose a reason for hiding this comment

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

Some notes on grammar and wording. Just followed the guide myself, and syntax highlighting seems to work great! Markdefinitely appreciate this 👏

packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
packages/integrations/markdoc/README.md Outdated Show resolved Hide resolved
ElianCodes and others added 2 commits August 25, 2023 19:03
Co-authored-by: Ben Holmes <hey@bholmes.dev>
@ElianCodes ElianCodes merged commit 6cfaf75 into withastro:main Aug 25, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants