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: fix typedoc links and add missing packages #5850

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@
**/vite.prod.config.js
**/node_modules
.ts-temp
**/.docusaurus
/playwright-report
7 changes: 0 additions & 7 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,6 @@ module.exports = {
'header/header': [2, 'scripts/www/headerTemplate.js'],
},
},
{
// don't lint headers in entrypoint files so we can add TypeDoc module comments
files: ['packages/**/src/index.ts'],
rules: {
'header/header': OFF,
},
},
{
// These aren't compiled, but they're written in module JS
files: ['packages/lexical-playground/esm/*.mjs'],
Expand Down
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ packages/**/vite.prod.config.js
flow-typed
.github/CODEOWNERS
.prettierignore
**/.docusaurus
/playwright-report
8 changes: 5 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion packages/lexical-clipboard/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/clipboard */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
2 changes: 0 additions & 2 deletions packages/lexical-code/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
/** @module @lexical/code */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*
*/

export {
Expand Down
2 changes: 1 addition & 1 deletion packages/lexical-devtools-core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# `@lexical/devtools-core`

[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_devtools-core)
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_devtools_core)

This package contains tools necessary to debug and develop Lexical.
1 change: 0 additions & 1 deletion packages/lexical-devtools-core/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/devtools-core */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
2 changes: 0 additions & 2 deletions packages/lexical-dragon/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
/** @module @lexical/dragon */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*
*/

import {
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-file/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/file */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-hashtag/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/hashtag */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-headless/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/headless */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-history/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/history */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-html/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/html */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-link/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/link */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-list/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/list */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-mark/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/mark */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-markdown/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/markdown */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-offset/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/offset */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-overflow/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/overflow */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-plain-text/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/plain-text */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-rich-text/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/rich-text */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-selection/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/selection */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-table/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/table */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-text/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/text */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
1 change: 0 additions & 1 deletion packages/lexical-utils/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/** @module @lexical/utils */
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
Expand Down
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-clipboard.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 7
sidebar_label: '@lexical/clipboard'
cache_reset: 1
---

{@import ../../../lexical-clipboard/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-code.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 13
sidebar_label: '@lexical/code'
cache_reset: 1
---

{@import ../../../lexical-code/README.md}
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 20
sidebar_label: '@lexical/devtools-core'
cache_reset: 1
---

{@import ../../../lexical-devtools-core/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-dragon.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 15
sidebar_label: '@lexical/dragon'
cache_reset: 1
---

{@import ../../../lexical-dragon/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-file.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 15
sidebar_label: '@lexical/file'
cache_reset: 1
---

{@import ../../../lexical-file/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-hashtag.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 14
sidebar_label: '@lexical/hashtag'
cache_reset: 1
---

{@import ../../../lexical-hashtag/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-headless.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 16
sidebar_label: '@lexical/headless'
cache_reset: 1
---

{@import ../../../lexical-headless/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-history.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 8
sidebar_label: '@lexical/history'
cache_reset: 1
---

{@import ../../../lexical-history/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-html.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 4
sidebar_label: '@lexical/html'
cache_reset: 1
---

{@import ../../../lexical-html/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-link.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 15
sidebar_label: '@lexical/link'
cache_reset: 1
---

{@import ../../../lexical-link/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-list.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 9
sidebar_label: '@lexical/list'
cache_reset: 1
---

{@import ../../../lexical-list/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-mark.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 4
sidebar_label: '@lexical/mark'
cache_reset: 1
---

{@import ../../../lexical-mark/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-markdown.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 11
sidebar_label: '@lexical/markdown'
cache_reset: 1
---

{@import ../../../lexical-markdown/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-offset.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 12
sidebar_label: '@lexical/offset'
cache_reset: 1
---

{@import ../../../lexical-offset/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-overflow.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 4
sidebar_label: '@lexical/overflow'
cache_reset: 1
---

{@import ../../../lexical-overflow/README.md}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: ''
sidebar_position: 2
sidebar_label: '@lexical/plain-text'
---

Expand Down
6 changes: 6 additions & 0 deletions packages/lexical-website/docs/packages/lexical-react.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: ''
sidebar_label: '@lexical/react'
---

{@import ../../../lexical-react/README.md}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: ''
sidebar_position: 3
sidebar_label: '@lexical/rich-text'
---

Expand Down
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-selection.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 4
sidebar_label: '@lexical/selection'
cache_reset: 1
---

{@import ../../../lexical-selection/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-table.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 10
sidebar_label: '@lexical/table'
cache_reset: 1
---

{@import ../../../lexical-table/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-text.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 5
sidebar_label: '@lexical/text'
cache_reset: 1
---

{@import ../../../lexical-text/README.md}
2 changes: 0 additions & 2 deletions packages/lexical-website/docs/packages/lexical-utils.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: ''
sidebar_position: 6
sidebar_label: '@lexical/utils'
cache_reset: 1
---

{@import ../../../lexical-utils/README.md}
6 changes: 6 additions & 0 deletions packages/lexical-website/docs/packages/lexical-yjs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: ''
sidebar_label: '@lexical/yjs'
---

{@import ../../../lexical-yjs/README.md}
Loading
Loading