Sébastien Lorber
42ab07f62f
feat(theme-classic): themeConfig navbar/footer logos accept className/style + update Meta Open-Source Logo ( #7643 )
2022-06-23 11:22:27 +02:00
Joshua Chen
e12a2efaeb
docs: normalize capitalization ( #7619 )
2022-06-15 13:04:33 +08:00
Joshua Chen
aeb6c971c0
docs: normalize capitalization ( #7613 )
2022-06-14 14:01:06 +08:00
Joshua Chen
ab566ecce3
docs: remove useless front matter ( #7518 )
2022-05-28 19:07:45 +08:00
Joshua Chen
9fd5d62340
docs: enhance docs about Markdown TOC and metadata ( #7278 )
...
* docs: multiple documentation improvements
* fix
* fix
2022-04-30 21:30:14 +08:00
Joshua Chen
ff1b7168ba
chore: upgrade dependencies ( #6916 )
2022-03-15 13:16:21 +08:00
Joshua Chen
39b66d82ef
feat(core): rework swizzle CLI ( #6243 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-25 14:13:15 +01:00
Joshua Chen
c1e3801ee7
fix(cli): allow passing a list of file names to write-heading-ids ( #6500 )
2022-01-29 12:21:15 +08:00
Joshua Chen
59022c5eea
docs: add advanced guides ( #6296 )
...
* docs: add advanced guides
* complete
* fix link
* Create architecture
* use png
* explanations
* more text
* process.env.NODE_ENV
* typo
* Add image zoom
* nit
* nit
* reorganize
* fix links
* fix links
* reorganize
* elaborate on presets
* fix
* routing docs
* ssr section
* more content
* complete SSR guide
* pathname://
* improvements
* document executionenvironment
* reformat
* final tweaks!
* avoid slug
* oops
2022-01-25 11:29:18 +08: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
01676329e1
docs: split sidebar documentation into sections ( #6450 )
...
* docs: split sidebar documentation into sections
* set slugs
* fix links
2022-01-23 17:50:48 +08:00
Joshua Chen
1d957d97e8
fix(migrate): migration CLI should correctly migrate gtag options ( #6276 )
...
* fix(migrate): migration CLI should correctly migrate gtag options
* fix
2022-01-06 20:39:23 +08:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting ( #6223 )
2021-12-30 10:51:00 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues ( #6203 )
...
* docs: audit grammar mistakes
* fix code block language
* revert change
* let's get another
2021-12-27 19:34:04 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +01:00
colton
638a171673
docs: update link to init template README.md ( #6134 )
...
Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-12-20 08:47:36 +08:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages ( #5728 )
2021-10-19 20:15:11 +02:00
Sébastien Lorber
f6ec757aa0
feat: npm init docusaurus, yarn create docusaurus ( #5635 )
...
* initial create-docusaurus impl
* cleanup
* @docusaurus/init renamed to create-docusaurus
* 0.0.6
* update lockfile
* fix lint
* remove npm2yarn for "npm init" because npm2yarn doesn't convert it and yarn result fails to execute
* prettier
* add correct version
* prettier
* prettier
* prettier
* prettier
* fix annoying --config .prettierrc issue
2021-10-07 16:06:42 +02:00
Joshua Chen
e274c72642
docs: fix more references to Discord channels ( #5585 )
2021-09-19 09:45:21 +03: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
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main ( #5345 )
...
* Prepare to renaming master branch to main
* Update CONTRIBUTING.md
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
* missing master -> main replaces
* useless char
* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required
* fix versioning page
* fix vercel links
* update deployment.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
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
