Skip to content

Commit

Permalink
docs: ✏️ update links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Saul-Mirone committed Feb 15, 2023
1 parent e0bddb9 commit 5979620
Show file tree
Hide file tree
Showing 29 changed files with 38 additions and 38 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,21 @@ For more information, please check our [official documentation website](https://

# What's Next

You can check our [Milkdown TODO](https://github.com/users/Saul-Mirone/projects/4/views/5) project page to know what's on the plan.
You can check our [Milkdown TODO](https://github.com/orgs/Milkdown/projects/1) project page to know what's on the plan.

You can also check [milestones](https://github.com/Saul-Mirone/milkdown/milestones) to know what's being worked on.
You can also check [milestones](https://github.com/Milkdown/milkdown/milestones) to know what's being worked on.

# Community

Welcome to join our [Discord community][discord-link].

# Contributing

Follow our [contribution guide](https://github.com/Saul-Mirone/milkdown/blob/main/CONTRIBUTING.md) to learn how to contribute to milkdown.
Follow our [contribution guide](https://github.com/Milkdown/milkdown/blob/main/CONTRIBUTING.md) to learn how to contribute to milkdown.

# Contributor

<a href="https://github.com/Saul-Mirone/milkdown/graphs/contributors">
<a href="https://github.com/Milkdown/milkdown/graphs/contributors">
<img src="https://opencollective.com/milkdown/contributors.svg?width=890&button=false" alt="contributors">
</a>

Expand All @@ -50,8 +50,8 @@ Special thanks to [@Meo](https://github.com/Saul-Meo) for her work in design.

If you like this project, please consider fund me to help the maintenance.

<a href="https://github.com/sponsors/Saul-Mirone">
<img src="/../../../../Saul-Mirone/Saul-Mirone/blob/main/sponsors.svg">
<a href="https://github.com/sponsors/Milkdown">
<img src="/../../../../Milkdown/Milkdown/blob/main/sponsors.svg">
</a>

# Thanks
Expand Down Expand Up @@ -92,13 +92,13 @@ Thanks to the following projects for their support to milkdown and the open sour

[MIT](/LICENSE)

[ci-badge]: https://github.com/Saul-Mirone/milkdown/actions/workflows/ci.yml/badge.svg
[ci-link]: https://github.com/Saul-Mirone/milkdown/actions/workflows/ci.yml
[ci-badge]: https://github.com/Milkdown/milkdown/actions/workflows/ci.yml/badge.svg
[ci-link]: https://github.com/Milkdown/milkdown/actions/workflows/ci.yml
[ts-badge]: https://badgen.net/badge/-/TypeScript/blue?icon=typescript&label
[download-badge]: https://img.shields.io/npm/dm/@milkdown/core
[download-link]: https://www.npmjs.com/search?q=%40milkdown
[version-badge]: https://img.shields.io/npm/v/@milkdown/core
[commit-badge]: https://img.shields.io/github/commit-activity/m/Saul-Mirone/milkdown
[license-badge]: https://img.shields.io/github/license/Saul-Mirone/milkdown
[commit-badge]: https://img.shields.io/github/commit-activity/m/Milkdown/milkdown
[license-badge]: https://img.shields.io/github/license/Milkdown/milkdown
[discord-badge]: https://img.shields.io/discord/870181036041060352
[discord-link]: https://discord.gg/SdMnrSMyBX
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/core).

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/ctx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/ctx).

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/exception/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Internal exception for [milkdown](https://milkdown.dev/).

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-block/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-clipboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-clipboard/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const isPureText = (content: UnknownRecord | UnknownRecord[] | undefined | null)
export const clipboard = $prose((ctx) => {
const schema = ctx.get(schemaCtx)

// Set editable props for https://github.com/Saul-Mirone/milkdown/issues/190
// Set editable props for https://github.com/Milkdown/milkdown/issues/190
ctx.update(editorViewOptionsCtx, prev => ({
...prev,
editable: prev.editable ?? (() => true),
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-collaborative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/collab

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-cursor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-diagram/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-emoji/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-history/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-indent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-listener/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-math/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-prism/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-slash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-tooltip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-trailing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/plugin-upload/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/plugin

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/preset-commonmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/preset

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,5 @@ export const defaultConfig: InlineSyncConfig = {
/// }));
/// ```
///
/// You can find the default config [here](https://github.com/Saul-Mirone/milkdown/blob/main/packages/preset-commonmark/src/plugin/inline-sync-plugin/config.ts).
/// You can find the default config [here](https://github.com/Milkdown/milkdown/blob/main/packages/preset-commonmark/src/plugin/inline-sync-plugin/config.ts).
export const inlineSyncConfig = $ctx<InlineSyncConfig, 'inlineSyncConfig'>(defaultConfig, 'inlineSyncConfig')
2 changes: 1 addition & 1 deletion packages/preset-gfm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/preset

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/prose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/prose)

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/react)

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/theme-nord/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/theme-

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/transformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/transf

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Check API on [document website](https://milkdown.dev/#/using-utils-package).

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion packages/vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Documentation can be found on the [Milkdown website](https://milkdown.dev/vue).

# License

Milkdown is open sourced software licensed under [MIT license](https://github.com/Saul-Mirone/milkdown/blob/main/LICENSE).
Milkdown is open sourced software licensed under [MIT license](https://github.com/Milkdown/milkdown/blob/main/LICENSE).

0 comments on commit 5979620

Please sign in to comment.