3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-25 23:17:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat: properly type-check the Docusaurus config of new sites (#5589)

Browse source 
* fix: makes types DocusaurusConfig optional to match docs

* add UserDocusaurusConfig with required keys for user config

* convert UserDocusaurusConfig to use util type

* Docusaurus website config should be type-checked by CI + fix all existing issues

* add doc for config typechecking

* Update template configs for TS autocompletion

* fix last config typechecking bugs

* reapply prettier

* reapply prettier-docs

* Fix TS doc: add missing ()

* fix some docu plugin types

* add "const config" for simpler jsdoc annotation

Co-authored-by: slorber <lorber.sebastien@gmail.com>
This commit is contained in:
Bharat Middha 2021-09-30 08:49:44 -07:00 • committed by GitHub
parent 3f1f8255a2
commit 09550b0535
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 115 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-mdx-loader/src/types.d.ts vendored
View file

@ -11,7 +11,7 @@ declare module '@docusaurus/mdx-loader' {
[Function, Record<string, unknown>] | Function;
export type RemarkAndRehypePluginOptions = {
remarkPlugins: RemarkOrRehypePlugin[];
rehypePlugins: string[];
rehypePlugins: RemarkOrRehypePlugin[];
beforeDefaultRemarkPlugins: RemarkOrRehypePlugin[];
beforeDefaultRehypePlugins: RemarkOrRehypePlugin[];
};