{"id":20459507,"url":"https://github.com/oschina/tide","last_synced_at":"2025-04-13T05:51:09.608Z","repository":{"id":233622371,"uuid":"653575794","full_name":"oschina/tide","owner":"oschina","description":"🪼 开箱即用、扩展性强、支持 Markdown 语法、基础功能完善的 React 富文本编辑器。","archived":false,"fork":false,"pushed_at":"2023-06-29T02:26:57.000Z","size":5428,"stargazers_count":40,"open_issues_count":1,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-26T22:36:07.455Z","etag":null,"topics":["editor","markdown","prosemirror","react","wysiwyg-editor"],"latest_commit_sha":null,"homepage":"https://oschina.gitee.io/tide","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oschina.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-06-14T10:10:19.000Z","updated_at":"2024-07-29T08:27:33.000Z","dependencies_parsed_at":"2024-04-17T00:05:05.427Z","dependency_job_id":"bd33714c-ed11-4d0b-a4f2-00fd15cd4b9d","html_url":"https://github.com/oschina/tide","commit_stats":null,"previous_names":["oschina/tide"],"tags_count":704,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oschina%2Ftide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oschina%2Ftide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oschina%2Ftide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oschina%2Ftide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oschina","download_url":"https://codeload.github.com/oschina/tide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670500,"owners_count":21142901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["editor","markdown","prosemirror","react","wysiwyg-editor"],"created_at":"2024-11-15T12:16:17.648Z","updated_at":"2025-04-13T05:51:09.587Z","avatar_url":"https://github.com/oschina.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Tide 🪼](https://gitee.com/oschina/tide)\n\nTide is a React-based rich text editor with out-of-the-box functionality, strong extensibility, and comprehensive support for Markdown syntax.\n\n[![Version](https://img.shields.io/npm/v/@gitee/tide.svg?label=version)](https://www.npmjs.com/package/@gitee/tide)\n[![Downloads](https://img.shields.io/npm/dm/@gitee/tide.svg)](https://npmcharts.com/compare/@gitee/tide?minimal=true)\n[![License](https://img.shields.io/npm/l/@gitee/tide.svg)](https://www.npmjs.com/package/@gitee/tide)\n\n## Online Demo\n\nhttps://oschina.gitee.io/tide\n\n![](./docs/images/tide-screenshot.jpg)\n\n## Example Code\n\n- [Basic Usage](./packages/editor/README.md)\n- [Advanced Usage](./apps/demo)\n- [Real-world Usage](./apps/legacy)\n\n## Features\n\n- JSON-based storage format\n- Supports Markdown shortcut syntax\n  - Headings\n  - Quotes\n  - Code blocks\n  - Tables\n  - Hyperlinks\n  - Images\n  - Separators\n  - Bold, italic, strikethrough\n  - Unordered lists, ordered lists, task lists\n- Supports pasting Markdown text\n- Supports enhanced Table functionality\n- Supports pasting and dragging images\n- Supports Emoji selection\n- Built-in menu bar\n- Supports multiple themes\n\n## Directories\n\n```\n.\n├── apps\n│   ├── demo                      # Demo project deployed on Pages, URL: https://oschina.gitee.io/tide\n│   └── legacy                    # Real-world project used by Gitee Community Edition,\n│                                 # package name is @gitee/tide-legacy\n├── presets                       # Presets with UI and configuration for @, #, ! mention functionality,\n│                                 # mainly used by @gitee/tide-legacy\n├── docs                          # Documentation (to be completed), including contribution guidelines\n├── packages                      # Directory for organizing monorepo packages\n│   ├── editor                    # Out-of-the-box editor base package, package name is @gitee/tide\n│   ├── starter-kit               # Integrates commonly used extension packages with the @gitee/tide package\n│   │                             # to provide an out-of-the-box experience\n│   ├── common                    # Common utility classes, etc.\n│   ├── react                     # React wrapper for the editor, facilitating usage in React projects\n│   ├── extension-*               # Packages starting with extension- that provide\n│   │                             # extension functionality for the editor\n│   ├── tsconfig                  # Unified tsconfig configuration\n│   └── eslint-config-custom      # Unified eslint configuration\n└── scripts                       # Scripts to simplify the development process, etc.\n```\n\n## Build and Run\n\nTide uses [turborepo](https://turbo.build/repo) to manage the compilation and distribution of multiple npm packages and [pnpm](https://pnpm.io) to manage local dependencies.\n\n```shell\ngit clone https://gitee.com/oschina/tide.git\n\ncd tide\n\n# Install dependencies\npnpm i\n\n# Build packages\npnpm build\n\n# Run the demo for development, it will automatically open the browser\npnpm dev:demo --open\n```\n\n\u003e Due to the complex dependency relationships in the monorepo, local builds are not currently supported for use through `npm link`, `yarn link`, and `pnpm link --global`.\n\n## Contributing\n\n- For bug reports, please use [Issues](https://gitee.com/oschina/tide/issues)\n- For code contribution, please use [Pull Request](https://gitee.com/oschina/tide/pulls). Before creating a pull request, please read [CONTRIBUTING.md](./docs/CONTRIBUTING.md)\n\n## Who's Using Tide\n\n- [Gitee Enterprise Edition](https://e.gitee.com)\n- [Gitee Community Edition](https://gitee.com)\n\n## Credits\n\n- [Tiptap](https://github.com/ueberdosis/tiptap)\n- [ProseMirror](https://github.com/ProseMirror/prosemirror)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foschina%2Ftide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foschina%2Ftide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foschina%2Ftide/lists"}