Commit graph

71 commits

Author SHA1 Message Date
Joshua Chen
24156efcfb
feat: docs plugin options sidebarCollapsible + sidebarCollapsed (#5203)
* Add prop

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

* Add `collapsible` option to sidebar item

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

* Add eslint-ignore

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

* Move new page

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

* Allow in autogenerated

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

* Fix tests

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

* Move config options to plugin-docs

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

* Make non-collapsible items always expanded

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

* docs versioning cli should receive a single options object

* Update cli.test.ts

* revert validateCategoryMetadataFile change

* remove theme usage of themeConfig.sidebarCollapsible

* better handling of sidebar item category inconsistencies + add warning message

* Update snapshot

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

* Handle plugin option inconsistencies

* improve doc for new sidebarCollapsible doc options

* remove warning in fixSidebarItemInconsistencies as it will be annoyed for versioned sites, as "collapsed" is already persisted in sidebar json files

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-23 14:24:36 +02:00
Sébastien Lorber
57a0a69137
docs(v2): v2 migration guide: mention Algolia config update (#4885) 2021-06-02 12:02:57 +02:00
Jonathan Mazin
60e2de6c04
docs(v2): grammar typo in migration-overview.md (#4880)
Small grammatical change
2021-06-01 17:50:45 +02:00
Sébastien Lorber
85cf1be79a
docs(v2): Docusaurus 2 beta blog post (#4756)
* draft

* draft

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* update draft

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

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

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

* update draft post

* link to testimonials collection

* remove alpha mention in doc

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Joel Marcey <joelm@fb.com>
2021-05-12 16:08:07 +02:00
Sébastien Lorber
fe6492aa87
docs(v2): Improve intro doc (#4770)
* Intro documentation refactoring

* useless images

* improve the intro doc
2021-05-12 14:40:35 +02:00
Sébastien Lorber
78349480af
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490)
* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs

* Cleanup v2.docusaurus.io urls

* add netlify domain redirect

* remove circleci config

* remove another circle file
2021-03-22 20:57:49 +01:00
Sébastien Lorber
aaea26602b
chore: prepare v1-v2 domain switch (#4475)
* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs
2021-03-22 20:26:47 +01:00
Arijit Kundu
af840b7f85
docs(v2, v1): fixed typos (#4479) 2021-03-22 18:00:32 +01:00
Sébastien Lorber
dd5e5098b8
docs(v2): Add missing i18n docs: API lifecycles + Crowdin migration guide (#4470)
* Add the missing i18n docs: Crowdin migration + i18n lifecycle APIs

* fix heading ids

* fix doc typo
2021-03-19 18:19:30 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
1c7d423e0c
docs(v2): various improvements (#4369)
* docs(v2): various improvements

* Update blog.md
2021-03-09 14:59:32 +01:00
Sébastien Lorber
b533847df8
docs(v2): v2 migration should mention RSS feed url change (#4236) 2021-02-17 14:35:29 +01:00
Nahiyan Kamal
30c8e26a31
docs(v2): typo of Word Process (#4129) 2021-01-31 22:40:45 +03:00
Sébastien Lorber
140bfbfd90
docs(v2): do not recommend using useBaseUrl() hook in most cases (#4126)
* doc: suggest not using useBaseUrl most of the time

* doc: suggest not using useBaseUrl most of the time
2021-01-29 19:10:38 +01:00
Sébastien Lorber
671748f065
docs(v2): Do not encourage using the permalink prop (#4112) 2021-01-28 10:33:43 +01:00
Sébastien Lorber
d99d53a236
docs(v2): Reorganize/split the guides doc sections (#3975)
* docs reorg

* refactor docs/markdown features section

* fix broken links after docs refactor
2020-12-30 17:03:25 +01:00
Sébastien Lorber
e5610a475d
docs(v2): Add migration info doc regarding docs folder location (#3962) 2020-12-29 10:57:35 +01:00
Sébastien Lorber
41ef333e47
feat(v2): inline table-of-contents + refactor TOC (#3904)
* Add TOCInline theme component

* Add TOCInline theme component doc + migration guide

* remove useless getPathsToWatch on classic theme

* rename rightToc to toc

* add temp theme-bootstrap TOCInline comp to fix build issue
2020-12-11 16:30:53 +01:00
Sébastien Lorber
70dece09e6
docs(v2): missing <ColorGenerator/> mdx import (#3871) 2020-12-03 18:17:04 +01:00
Matteo Manzinello
20114f5e0a
docs(v2): From docusaurus-migrate to @docusaurus/migrate (#3873)
Fix from docusaurus-migrate to @docusaurus/migrate
2020-12-03 18:16:07 +01:00
Sébastien Lorber
8f47babb46
docs(v2): Docs refactoring and reorganization (#3831)
* stable refactor of plugins api documentation

* plugins sidebar not collapsed by default as small?

* theme docs reorg

* Refactor migration guide doc

* fix broken link
2020-11-30 14:07:08 +01:00