3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-31 09:57:03 +02:00
Code Issues Projects Releases Packages Wiki Activity
4043 commits 47 branches 177 tags 950 MiB
Commit graph

1363 commits

Author SHA1 Message Date
Sébastien Lorber
a0c2c52829
chore: remove unused Bootstrap theme (#5634) 
* remove package

* remove bootstrap from doc

* remove bootstrap init template + examples

* remove bootstrap preset

* remaining bootstrap refs

* update lockfile
 2021-10-01 17:44:34 +02:00
Sébastien Lorber
afff053cc9
chore: prepare Algolia migration (#5632) 
* prepare Algolia migration

* Update website/docs/search.md

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>
 2021-10-01 15:58:24 +02:00
Sébastien Lorber
9d129631b6
fix: text/link hydration bug (#5629) 2021-09-30 19:54:40 +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
Dr-Electron
caba1e4908
docs: Add IOTA wiki to showcase (#5610) 
* Add IOTA wiki

* Update website/src/data/users.tsx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-09-28 16:35:57 +02:00
Alexey Pyltsyn
b62a12bfc6
chore: upgrade dependencies (#5608) 
* chore: upgrade dependencies

* Revert github-slugger

* Fixes

* Update snapshots

* Update Babel deps
 2021-09-24 16:36:41 +02:00
Jason Bosco
81877d7582
docs: add additional search options, typesense and local search (#5489) 
* docs: add additional search bar options - typesense and local search

* docs: add typesense docsearch to community resources

* improve search doc, explain better where to get support

* improve search doc

* improve search doc

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-09-22 17:41:27 +02:00
Joshua Chen
e1f4677d04
fix(module-type-aliases): move @type packages to dependencies (#5601) 
* Move devDeps to deps

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

* Update docs

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

* Update init template

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
 2021-09-22 14:49:25 +02:00
Joshua Chen
89cb975cc4
docs(website): document npm2yarn plugin + use new Tabs API everywhere (#5590) 
* Update docs

* Bad grammar

* Add code highlight
 2021-09-22 12:25:21 +02:00
Whirl
57c7a302fa
docs: Add whirl.codes to showcase (#5591) 
* added for whirl

* Update users.tsx

* Delete unknown[2].png

* Add files via upload

* Update users.tsx
 2021-09-22 11:41:55 +02:00
Alexey Pyltsyn
29e06d0677
feat: make tags route path configurable (#5545) 2021-09-21 19:19:18 +02:00
headline-design
73b845e915
docs: add Pipeline UI to showcase (#5574) 
* Update users.tsx

* Update users.tsx

Specify website/source for PIPELINE-UI

* Add files via upload

add pipeline-ui to showcase

* add pipeline-ui to showcase

* Update users.tsx

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-09-19 09:45:47 +03:00
Joshua Chen
e274c72642
docs: fix more references to Discord channels (#5585) 2021-09-19 09:45:21 +03:00
Palash Shrivastava
ceff278449
docs: add Blogasaurus to showcase (#5572) 
* Update users.tsx

Add Blogasaurus

* add blogasaurus image

* update filename

* delete 'PNG' file

* add 'png' file

* update users.tsx with 'png' file
 2021-09-19 09:44:26 +03:00
Alexey Pyltsyn
19302c4913
docs: clarify MDX version used (#5575) 
* docs: clarify MDX version used

* Update MDX Playground link
 2021-09-17 21:27:00 +03:00
Joshua Chen
cc75e85adb
docs: update all Discord links (#5581) 2021-09-17 21:25:31 +03:00
Chris Chinchilla
beedadd498
docs: fix code example (#5566) 2021-09-15 18:19:53 +03:00
Jordan Lee
546bf5db4c
docs: minor grammatical correction (#5559) 2021-09-15 18:18:51 +03:00
Kyriet
9a089d4886
docs: add note about partials on Create doc page (#5543) 2021-09-11 12:42:17 +03:00
Robert Kingston
0f5efc976f
docs: Add Mint Metrics site to the Showcase (#5549) 
Co-authored-by: Robert Kingston <rob@mintmetrics.io>
 2021-09-11 12:38:38 +03:00
Ivar Conradi Østhus
83b05772d5
docs: add Unleash to showcase (#5546) 
* docs: add unleash to showcase

* Fix URL

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-09-09 13:11:59 +03:00
Forresst
02eee61aa5
docs: improve escape pipe in Markdown tables (#5539) 
* Test escape pipe in Markdown table 

From a remark on Crowdin:
> The value for the Type entry in the plugin-content-blog page is strange.
> In English documents, the Type item value is normally displayed.
> ex) editUrl: string | EditUrlFunction
> However, in French documentation, the Type item value is shown as an unknown code.
> ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!!
> ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!!

This is a test to see if the other way to escape a pipe in a markdown table could solve the problem.

* Fix all docs to replace &#124; by \|

* Keep `code`

* Apply suggestions from code review

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-09-08 14:58:48 +03:00
Sébastien Lorber
4f59f0782e
docs: mention Netlify ignore build setting (#5486) 
* mention Netlify ignore build setting

* doc backport
 2021-09-03 19:34:10 +02:00
Daniel Costrasel
09a7e0b00b
docs: update docusaurus-plugin-relative-paths description (#5482) 2021-09-03 14:44:34 +02:00
swyx
194f429c1f
fix: add docs tag validation to solve #5478 (#5479) 
* fix: add docs tag validation to solve #5478

fix: add docs tag validation to solve #5478

* Update docFrontMatter.ts

* Update docs-create-doc.mdx

* improve tag validation error messages + tests

* improve tags doc

* fix test

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-09-03 14:43:24 +02:00
Sébastien Lorber
fd3c0c6619
chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +02:00
Sébastien Lorber
2611bbb501
chore(v2): prepare v2.0.0-beta.6 release (#5473) 
* add beta.6

* v2.0.0-beta.6
 2021-09-02 18:31:42 +02:00
Gabriel Csapo
cb8718a1e3
feat: adds blog archive route (#5428) 
* [feature] adds blog archive route

* Update plugin-content-blog.md

* fix TS issues + minor refactors

* remove useless css

* add translation apis

* add missing translations

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-09-02 17:35:13 +02:00
Daniel Costrasel
e5d9ff18a8
docs: Add docusaurus-plugin-relative-paths (#5471) 2021-09-02 17:18:50 +02:00
Oscar Lorentzon
9918c3c45e
docs: add mapillary-js to showcase (#5464) 2021-09-02 16:08:59 +02:00
Joshua Chen
5f003bcabd
feat(theme-classic): allow passing tab label and default value through TabItem (#5442) 
* Implement feature

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

* Dogfood edge case

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

* Correct keydown handling

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

* Update index.tsx

* Update markdown-features-tabs.mdx

* Update markdown-features-tabs.mdx

* polish tabs doc

* Update markdown-features-tabs.mdx

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-09-01 12:44:37 +02:00
Sébastien Lorber
553f914639
feat: TypeScript presets/plugins should expose Options typing (#5456) 
* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme

* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme

* fix remaining TS errors

* fix remaining TS errors

* TS fix

* Add JSDoc type annotations to init templates and TS docs

* missing title char
 2021-09-01 12:14:40 +02:00
Sébastien Lorber
d76091c7fe
fix: website bad version name in docusaurus.config.js (#5455) 2021-08-31 17:40:47 +02:00
Sébastien Lorber
42e70e6d42
feat: new docs options: versions.{badge,className} (#5454) 
* docs: add versions.{badge,className} options

* remove badge option test
 2021-08-31 15:40:37 +02:00
Joshua Chen
df3752cc71
fix: fix a few TS errors (#5437) 
* fix errors

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

* Fix website

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

* Revert adding lib

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

* Fix tsconfig

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

* Restore previous ordering

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

* exclude sw.js from typechecking

* Tests: include typechecking of website

* cleanup @site/ alias in TS config

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-08-30 13:06:00 +02:00
Joshua Chen
1481bc2eb7
docs: document doc tags + refinements (#5433) 
* Various improvements

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

* Oops

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
 2021-08-30 11:03:03 +02:00
Antony Messerli
49c5f3ed41
docs: Add netboot.xyz to site showcase (#5435) 
* Add netboot.xyz to site showcase

* Add files via upload
 2021-08-30 10:27:28 +02:00
Rohit Gohri
c7f337e3b5
docs: add Redocusaurus in community plugin list (#5436) 
Ref: 
- https://github.com/facebook/docusaurus/issues/638#issuecomment-762502498
- https://github.com/rohit-gohri/redocusaurus
 2021-08-28 21:25:37 +03:00
Sébastien Lorber
f600d5a6d7
chore: prepare v2.0.0-beta.5 release (#5427) 
* beta.5

* v2.0.0-beta.5
 2021-08-26 17:33:31 +02:00
Alexey Pyltsyn
0dd4892b0f
refactor: improve styles of Details component (#5402) 
* refactor: improve styles of Details component

* Use vendor prefix for ::marker

* Wording
 2021-08-26 16:46:35 +02:00
Alexey Pyltsyn
e6f4a9b231
docs: clarify using custom attributes for navbar link (#5423) 2021-08-26 14:29:05 +02:00
Joshua Chen
493225a3c6
feat(plugin-blog): multi-authors support + authors.yml global configuration (#5396) 
* Complete function

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

* A lot of blank lines

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

* More lenient validation

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

* Remove or

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

* Simpler logic

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

* Expand docs

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

* Better docs

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

* Dogfood

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

* More writeup

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

* Polish

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

* Polish

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

* Move mergeAuthorMap to authors.ts

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

* Unbreak relative assets

* Update docs

* Clarify in docs

* simplify feed authors

* rename authorMap -> authorsMap

* mergeAuthorsMap -> getBlogPostAuthors

* website => 5 blog posts per page

* improve authors map file

* Extract new theme authors components + display in row

* add comment for meta array syntaxes

* blog => getPathsToWatch should watch authorsMap file

* remove useless v1 blog FBID frontmatter

* keep older frontmatter syntax for now

* revert blog frontmatter

* Better console message

* better blog authors frontmatter impl

* add multi authors to beta blog post + fix some authors margins

* fix React key

* Refactor: mdx loader should support a more flexible assets system (poc, not documented yet)

* better display of blog post authors: adapt layout to authors count + add line clamp

* smaller local image

* fix blog feed tests

* fix blog frontmatter tests + improve validation schema

* add more frontmatter tests

* add tests for getAuthorsMapFilePath

* tests for validateAuthorsMapFile

* add tests for readAuthorsMapFile

* test getAuthorsMap

* exhaustive tests for getBlogPostAuthors

* fix remaining tests

* missing blog plugin author tests

* fix windows tests

* improve blog multi-author's doc

* Use new format in init template

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

* Improve error message

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

* update feed snapshot

* blog authors: limit to 2 cols + fix margins for no authors

* minor doc improvements

* better init template blog posts, demonstrating Blog features

* replace the legacy blog author frontmatter in remaining places

* Prefer using clsx

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

* cleanup getColClassName

* remove blog author name/title line-clamping

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-08-26 12:21:58 +02:00
Fouad Matin
8779c8ff4a
docs: add Indent to showcase (#5421) 
* docs: add Indent to showcase

* docs: add Indent preview

* fix: missing source field
 2021-08-26 12:17:21 +02:00
Julien Neuhart
2a9f5903cf
docs: add Gotenberg to showcase (#5405) 2021-08-23 00:19:32 +03:00
Palash Shrivastava
b665b5b859
docs: specify proper min Node.js version in Travis CI example (#5406) 2021-08-23 00:13:53 +03:00
Sébastien Lorber
072a5a7e2e
fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching (#5399) 2021-08-20 19:37:20 +02:00
Sébastien Lorber
631c4685fb
chore: rename docusaurus-2-website package + refactor scripts (#5397) 2021-08-20 18:11:13 +02:00
Joshua Chen
8e1cde135c
feat: make blog config options and navbar versions dropdown label translatable (#5371) 
* Translate versions dropdown label

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

* Make blog options tranlatable

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

* Fix names

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

* Rename functions

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

* Rename translations path

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

* Update docs

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

* Update Chinese translations

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

* Remove space

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

* Update docs

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

* Add jest test

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

* Fix copyright typing

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

* Update test

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

* Update options

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

* Fix test

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
 2021-08-20 17:11:59 +02:00