3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-06 13:47:29 +02:00
Code Issues Projects Releases Packages Wiki Activity
5228 commits 47 branches 176 tags 883 MiB
Commit graph

352 commits

Author SHA1 Message Date
Joshua Chen
aa446b7a9c
chore: clean up ESLint config, enable a few rules (#6514) 
* chore: clean up ESLint config, enable a few rules

* enable max-len for comments

* fix build
 2022-01-31 10:31:24 +08:00
Joshua Chen
2553f1fb5a
refactor: improve internal typing (#6507) 
* refactor: improve internal typing

* fix

* fix test
 2022-01-29 22:58:40 +08:00
Joshua Chen
3c58d7f027
feat(content-docs): allow explicitly disabling index page for generated category (#6452) 
* feat(content-docs): allow explicitly disabling index page for generated category

* docs

* add test
 2022-01-27 23:14:07 +08:00
Joshua Chen
24a895fbc5
feat(content-docs): expose isCategoryIndex matcher to customize conventions (#6451) 
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
 2022-01-26 17:58:52 +01:00
Nick Schonning
521eb119a7
chore: add cSpell for spell checking (#6456) 
* chore: Add cSpell for spell checking

* chore: exclude map files and remove dups

* chore: exclude more binary files

* chore: remove MD headings

* Update .cspell.json

* fix a few spellings

* fix more

* fix

Signed-off-by: Joshua Chen <sidachen2003@gmail.com>

* fix a few

* oops

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2022-01-25 09:40:02 +08:00
Joshua Chen
64909e7f14
fix(content-docs): make getActivePlugin match plugin paths more exactly (#6435) 
* fix(content-docs): make getActivePlugin match plugin IDs more exactly

* refactor...
 2022-01-22 13:36:56 +08:00
Joshua Chen
45f1b819b5
feat(content-docs): displayed_sidebar front matter (#5782) 2022-01-19 16:00:42 +01:00
Joshua Chen
62223ee556
test: improve test coverage (#6387) 
* test: improve test coverage

* fix

* use posixPath
 2022-01-18 16:29:40 +08:00
Joshua Chen
3cb0972b79
refactor: use findAsyncSequential in a few places (#6377) 
* refactor: use findAsyncSequential in a few places

* fixes

* fix
 2022-01-17 08:57:06 +08:00
Joshua Chen
52db7320a6
chore: enable eslint-plugin-jest (#6375) 2022-01-16 15:53:23 +08:00
Tapan Chudasama
3e5944ef1f
fix: highlight appropriate navItem based on active sidebar item (#6310) 
* fix: highlight appropriate navItem based on active sidebar item

* fix: try using location.pathname

* fix: remote console.log

* fix: include category generated indices in globalData

* Add test

* fix snap

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2022-01-16 13:41:40 +08:00
Joshua Chen
cf265c051e
refactor: move exported type definitions to declaration file (#6300) 
* refactor: move exported type definitions to declaration file

* fix

* fix
 2022-01-09 22:02:31 +08:00
Sébastien Lorber
024f2bf49b
refactor: new @docusaurus/plugin-content-docs/client interface (#6287) 2022-01-07 17:04:21 +01:00
Joshua Chen
edab7e07ed
refactor(content-docs): make readVersionsMetadata async (#6277) 
* refactor(content-docs): make readVersionsMetadata async

* fix tests
 2022-01-06 21:46:08 +08:00
Minh Pham
eade41a702
feat(theme-classic): new navbar item linking to a sidebar (#6139) 
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
 2022-01-06 11:52:25 +01:00
Joshua Chen
3cb99124de
feat(content-docs): allow SEO metadata for category index pages (#6239) 2022-01-06 11:31:01 +01:00
Joshua Chen
cb1aa30286
refactor: enforce type import specifiers (#6230) 
* refactor: enforce type import specifiers

* fix

* Upgrade esbuild

* Fix (haha)
 2021-12-31 21:17:09 +08:00
Joshua Chen
3195e7feed
fix(content-docs): quotify path when retrieving git history (#6202) 
* fix(content-docs): quotify path when retrieving git history

* Enable last update in dogfooding
 2021-12-27 17:27:48 +08:00
Sébastien Lorber
b393700a61
feat: async plugin creator functions (#6166) 2021-12-22 19:10:49 +01:00
Joshua Chen
287292497d
test: fix async tests resolved in random order (#6143) 2021-12-21 18:51:56 +08:00
Joshua Chen
770418f8d2
refactor: unify log format with new logger utility (#5994) 
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
 2021-12-20 17:24:59 +01:00
Joshua Chen
a5d2815154
fix(content-docs): restore behavior when pagination front matter is null (#6124) 
* fix(content-docs): restore behavior when pagination front matter is null

* update snaps
 2021-12-18 10:31:31 +08:00
Joshua Chen
74aa87242f
test: use snapshots for sidebar tests (#6123) 2021-12-17 18:17:09 +01:00
Sébastien Lorber
fd2934d10d
getMainDocId should return doc with both versioned or unversioned id (#6085) 2021-12-10 09:35:57 -08:00
Joshua Chen
fd966b5395
refactor: add blank lines below all copyright headers (#6071) 2021-12-09 11:53:46 +08:00
Joshua Chen
e07ebadf6c
fix: make Docusaurus PnP strict mode compatible (#6047) 
Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>
 2021-12-08 14:26:24 +01:00
Alexey Pyltsyn
f96a051fbe
refactor: remove deprecated docs homePageId option (#6065) 2021-12-07 19:48:30 +01:00
Alexey Pyltsyn
283166c211
refactor: remove unused metadata field for homepage (#6056) 2021-12-06 12:28:35 +08:00
Sébastien Lorber
cfae5d0933
feat(content-docs): sidebar category linking to document or auto-generated index page (#5830) 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-12-03 14:44:59 +01:00
Oliver Ullman
1366c31201
feat(core): allow sourcing from multiple static directories (#4095) 
* [WIP] Implementaion of multiple directory static sourcing

* Move default to validation

* Update test

* Refactor

* Port to MDX loader

* Fix

* Move dogfooding assets

* Doc writeup

* Restore assets

* Support absolute paths

* Dogfood absolute path

* Fix

* More tests

* Fix snapshots

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2021-11-18 22:26:26 +08:00
Joshua Chen
0374426ce3
chore: upgrade TypeScript & other ESLint related deps (#5963) 
* chore: upgrade ESLint related deps

* Upgrade TS

* Fix lock

* Bump Babel

* Update config
 2021-11-18 21:15:37 +08:00
Armano
2f7d6fea1e
refactor(content-docs): move isCategoriesShorthand to utils (#5962) 2021-11-18 08:25:07 +08:00
Joshua Chen
c5feac6ba2
refactor: move deps declarations into src (#5946) 2021-11-14 13:35:15 +08:00
Joshua Chen
d1308a8736
refactor: improve setup of type declaration files (#5914) 2021-11-12 17:47:27 +01:00
Swalah Amani
c541e2d83c
misc: replace all "Metadatas" with "Metadata" (#5871) 
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
 2021-11-09 19:46:10 +01:00
Joshua Chen
f12c390a17
fix(content-docs): do not echo git history to console (#5906) 2021-11-08 21:03:21 +08:00
Joshua Chen
a835c9bc48
misc(plugin-docs): fix Windows test snapshot for git history retrieval (#5905) 
* misc(plugin-docs): fix test snapshot

* Fix again
 2021-11-08 17:09:58 +08:00
Joshua Chen
334b4397e7
refactor(content-docs): use shelljs instead of execa (#5904) 2021-11-08 15:33:06 +08:00
Joshua Chen
1363a25819
refactor: use js-yaml to parse both JSON and YAML (#5806) 2021-11-03 17:55:14 +01:00
Joshua Chen
7a6607cfa1
refactor: remove a few Lodash usages & ESLint enforcement (#5807) 
* refactor: remove some lodash usage

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Enforce ESLint

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* More forbids

* Fixup

* Fix

* Fix website
 2021-10-28 12:48:58 +08:00
Joshua Chen
68c970175a
refactor: migrate lqip-loader to TS, fix typing for Webpack Loaders (#5779) 2021-10-27 16:38:11 +02:00
Joshua Chen
3127f12654
feat(content-docs): new front matter options to customize pagination (#5705) 2021-10-21 12:27:57 +02:00
Joshua Chen
8d92e9bcf5
refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types (#5678) 2021-10-14 14:38:26 +02:00
Joshua Chen
eaacb0e98a
feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization (#5642) 
* Initial work

* Complete function

* Avoid duplication

* More dedupe

* Make everything constants

* Change casing & docs
 2021-10-07 16:59:02 +02:00
Joshua Chen
7f7b858cd4
refactor: make all Props defined as interface + readonly (#5636) 
* Initial work

* Fix
 2021-10-05 19:04:24 +02:00
Bharat Middha
09550b0535
feat: properly type-check the Docusaurus config of new sites (#5589) 
* 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>
 2021-09-30 17:49:44 +02:00
Joshua Chen
3f1f8255a2
chore: upgrade Prettier + regenerate lock file (#5611) 
* Bump deps

* Run prettier

* Format docs

* Minor refactor

* Collapse objects

* Fix type

* Update lock file
 2021-09-30 12:54:17 +02:00
Erick Zhao
c86dfbda61
feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (#5578) 
* feat: add all TOC levels to MDX loader

* feat: add theme-level config for heading depth

* test: add remark MDX loader test

* fix: limit maxDepth validation to H2 - H6

* refactor: set default `maxDepth` using `joi`

* refactor: `maxDepth` -> `maxHeadingLevel

* refactor: invert underlying TOC depth API

* refactor: make TOC algorithm level-aware

* feat: add support for per-doc TOC heading levels

* feat: support document-level heading levels for blog

* fix: correct validation for toc level frontmatter

* fix: ensure TOC doesn't generate redundant DOM

* perf: simpler TOC heading search alg

* docs: document heading level props for `TOCInline`

* Update website/docs/guides/markdown-features/markdown-features-inline-toc.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* docs: fix docs (again)

* create dedicated  test file for heading searching logic: exhaustive tests will be simpler to write

* toc search: add real-world test

* fix test

* add dogfooding tests for toc min/max

* add test for min/max toc frontmatter

* reverse min/max order

* add theme minHeadingLevel + tests

* simpler TOC rendering logic

* simplify TOC implementation (temp, WIP)

* reverse unnatural order for minHeadingLevel/maxHeadingLevel

* add TOC dogfooding tests to all content plugins

* expose toc min/max heading level frontmatter to all 3 content plugins

* refactor blogLayout: accept toc ReactElement directly

* move toc utils to theme-common

* add tests for filterTOC

* create new generic TOCItems component

* useless css file copied

* fix toc highlighting className conflicts

* update doc

* fix types

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-09-29 11:19:11 +02:00
Alexey Pyltsyn
e66e045b74
fix(docs): create tags route if only tags exists (#5606) 2021-09-23 13:02:54 +02:00
Alexey Pyltsyn
29e06d0677
feat: make tags route path configurable (#5545) 2021-09-21 19:19:18 +02:00