Skip to content

[WIP] Add TypeDoc support #619

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

[WIP] Add TypeDoc support #619

wants to merge 1 commit into from

Conversation

ifiokjr
Copy link
Member

@ifiokjr ifiokjr commented Sep 1, 2020

Description

Add API documentation support via TypeDoc and typedoc-plugin-markdown.

Checklist

  • I have read the contributing document.
  • My code follows the code style of this project and pnpm fix completed successfully.
  • I have updated the documentation where necessary.
  • New code is unit tested and all current tests pass when running pnpm test.

Screenshots

Currently this is not building and will need some fixes on the typedoc-plugin-markdown.

The following code breaks the markdown implementation since HTML tags are not being escaped.

remirror/packages/jest-prosemirror/src/jest-prosemirror-nodes.ts

Lines 238 to 239 in 1fd87e9

export const tdCursor = td(p('<cursor>'));
export const thCursor = th(p('<cursor>'));

2020-09-01 20 55 30

@ifiokjr ifiokjr added type: docs 📝 Documentation related changes. type: external 🌍 This issue requires work to be done on a 3rd party code base. labels Sep 1, 2020
@ifiokjr ifiokjr added this to the Playground milestone Sep 1, 2020
@ifiokjr ifiokjr self-assigned this Sep 1, 2020
@changeset-bot
Copy link

changeset-bot bot commented Sep 1, 2020 •
edited
Loading

🦋 Changeset is good to go

Latest commit: 98ce067

We got this.

This PR includes changesets to release 73 packages
Name Type
@remirror/pm Patch
@remirror/core-types Patch
@remirror/core-utils Patch
@remirror/core Patch
@remirror/dev Patch
@remirror/dom Patch
@remirror/extension-annotation Patch
@remirror/extension-auto-link Patch
@remirror/extension-bidi Patch
@remirror/extension-blockquote Patch
@remirror/extension-bold Patch
@remirror/extension-code-block Patch
@remirror/extension-code Patch
@remirror/extension-collaboration Patch
@remirror/extension-diff Patch
@remirror/extension-doc Patch
@remirror/extension-drop-cursor Patch
@remirror/extension-emoji Patch
@remirror/extension-epic-mode Patch
@remirror/extension-events Patch
@remirror/extension-gap-cursor Patch
@remirror/extension-hard-break Patch
@remirror/extension-heading Patch
@remirror/extension-history Patch
@remirror/extension-horizontal-rule Patch
@remirror/extension-image Patch
@remirror/extension-italic Patch
@remirror/extension-link Patch
@remirror/extension-mention-atom Patch
@remirror/extension-mention Patch
@remirror/extension-paragraph Patch
@remirror/extension-placeholder Patch
@remirror/extension-position-tracker Patch
@remirror/extension-positioner Patch
@remirror/extension-react-component Patch
@remirror/extension-react-ssr Patch
@remirror/extension-search Patch
@remirror/extension-strike Patch
@remirror/extension-text Patch
@remirror/extension-trailing-node Patch
@remirror/extension-underline Patch
@remirror/extension-yjs Patch
@remirror/i18n Patch
@remirror/playground Patch
@remirror/preset-core Patch
@remirror/preset-embed Patch
@remirror/preset-list Patch
@remirror/preset-react-checkbox Patch
@remirror/preset-react Patch
@remirror/preset-social Patch
@remirror/preset-table Patch
@remirror/preset-wysiwyg Patch
@remirror/react-components Patch
@remirror/react-hooks Patch
@remirror/react-social Patch
@remirror/react-wysiwyg Patch
@remirror/react Patch
@remirror/testing Patch
jest-prosemirror Patch
jest-remirror Patch
remirror Patch
@remirror/storybook Patch
@remirror/core-helpers Patch
@remirror/react-utils Patch
@remirror/theme Patch
multishift Patch
test-keyboard Patch
@remirror/showcase Patch
@remirror/e2e Patch
@remirror/website Patch
with-next Patch
@remirror/cli Patch
prosemirror-suggest Patch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added the type: support 📚 A change focused on improving the architecture and structure of the support directory. label Sep 1, 2020
This was referenced Sep 1, 2020
Closed
Closed
@ifiokjr
Add TypeDoc support to docusaurus build
98ce067 
Also temporarily turn of hooks rule until this is merged
facebook/react#19751
@github-actions github-actions bot added framework: react ⚛️ Any changes to packages which are exclusively used for react code bases. package: @remirror/cli 📟 A label for the remirror cli. package: jest-prosemirror 🎭 A change has occured in the jest-prosemirror package. package: jest-remirror 🃏 Label for the jest-remirror package package: multishift 🔽 Add this label when updating the `multishift` package. package: remirror 🟣 Label for the remirror package and all relevant scoped `@remirror/*` packages. test: unit ✅ A label for updating tests and test configuration. type: changeset 🦋 A change has been made to the changesets folder. type: ui 💅 Changes made to user facing components and styles. labels Sep 5, 2020
@ifiokjr ifiokjr closed this Feb 2, 2021
@snyk-bot snyk-bot mentioned this pull request Apr 25, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@ifiokjr ifiokjr

Labels
framework: react ⚛️ Any changes to packages which are exclusively used for react code bases. package: jest-prosemirror 🎭 A change has occured in the jest-prosemirror package. package: jest-remirror 🃏 Label for the jest-remirror package package: multishift 🔽 Add this label when updating the `multishift` package. package: @remirror/cli 📟 A label for the remirror cli. package: remirror 🟣 Label for the remirror package and all relevant scoped `@remirror/*` packages. test: unit ✅ A label for updating tests and test configuration. type: changeset 🦋 A change has been made to the changesets folder. type: docs 📝 Documentation related changes. type: external 🌍 This issue requires work to be done on a 3rd party code base. type: support 📚 A change focused on improving the architecture and structure of the support directory. type: ui 💅 Changes made to user facing components and styles.
Projects
None yet
Milestone
Playground
Development

Successfully merging this pull request may close these issues.
1 participant
@ifiokjr