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

docs: Update Lit README.md #7990

Closed
wants to merge 1 commit into from

Conversation

liruifengv
Copy link
Member

@liruifengv liruifengv commented Aug 8, 2023

Changes

  • Update Lit README.md

Testing

Docs

Before

image

After

image

@liruifengv liruifengv requested a review from a team as a code owner August 8, 2023 03:37
@changeset-bot
Copy link

changeset-bot bot commented Aug 8, 2023

⚠️ No Changeset found

Latest commit: d8e9261

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 pkg: lit Related to Lit (scope) pkg: integration Related to any renderer integration (scope) labels Aug 8, 2023
@liruifengv
Copy link
Member Author

I also changed a code snippet in the Chinese translation. withastro/docs#4125

Before:

```diff
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
import lit from '@astrojs/lit';

export default defineConfig({
-  integrations: [vue(), lit()]
+  integrations: [lit(), vue()]
});
```

After:

```js  del={7} ins={8}
// astro.config.mjs
import { defineConfig } from 'astro/config';
import vue from '@astrojs/vue';
import lit from '@astrojs/lit';

export default defineConfig({
  integrations: [vue(), lit()]
  integrations: [lit(), vue()]
});
```

But it seems that it shouldn't be changed that way in the README. I don't know what to do.

@delucis
Copy link
Member

delucis commented Aug 8, 2023

Thanks @liruifengv! I actually fixed this in #7985 but haven't updated docs with it yet (will happen today via our automatic CI PR).

I think for your translation PR that version with ins/del is great! But yes, we should stick to using the diff version in the README so it displays well on GitHub and on npm.

@delucis delucis closed this Aug 8, 2023
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) pkg: lit Related to Lit (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants