Joshua Chen
1ca07f8466
refactor(content-docs): read category metadata files before autogenerating ( #6586 )
...
* refactor(content-docs): read category metadata files before autogenerating
* fix tests
* fix Windows...
* warn user when behavior is undetermined
* oops
* fix typo
2022-02-03 16:16:19 +08: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
Tamal Web
ade486d079
docs: mention where to find the sitemap ( #6492 )
...
* Added the sitemap url
So that users know where to locate their sitemaps
* Update plugin-sitemap.md
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-28 17:11:09 +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
Joshua Chen
76a8d5f38a
fix(content-blog): generate feed by reading build output ( #6454 )
2022-01-26 16:54:15 +01: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
Nick Schonning
2528226eeb
chore: add height/width for front page images ( #6385 )
...
* chore: add height/width for Lighthouse performance
* use auto width
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-23 09:57:31 +08:00
Joseph
8ce3cee400
feat(theme-classic): auto-collapse sibling categories in doc sidebar ( #3811 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2022-01-20 16:38:16 +01:00
Joshua Chen
d506bca12d
feat(content-blog): allow disabling generating archive ( #6415 )
2022-01-20 14:52:19 +01:00
Yaroslav Serhieiev
d296f44031
docs(i18n): amend PR #6371 ( #6406 )
2022-01-19 18:19:41 +01:00
Joshua Chen
db471d97ab
fix(website): various anchor link fixes ( #6318 )
2022-01-12 08:35:47 +08:00
Sébastien Lorber
f87a3ead46
refactor: move @theme/hooks to @docusaurus/theme-common ( #6289 )
2022-01-07 19:19:35 +01:00
Joshua Chen
06a8cdcb0f
docs: elaborate on doc versioning ( #6280 )
...
* docs: elaborate on doc versioning
* Complete
* fix
2022-01-07 14:28:48 +08:00
Joshua Chen
a03788374e
fix(website): fix config-tabs breaking after translation ( #6275 )
...
* fix(website): fix config-tabs breaking after translation
* more robust
2022-01-06 19:31:58 +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
8fe1ddf46a
feat(sitemap): remove trailingSlash option; respect noIndex config ( #6248 )
2022-01-05 17:56:17 +01:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting ( #6223 )
2021-12-30 10:51:00 +08:00
Joshua Chen
5132ecdeee
docs: normalize plugin API documentation ( #6193 )
...
* docs: normalize plugin API documentation
* Revert change
* Use remark plugin
* edits
* edit again
* Fixes
2021-12-28 21:23:27 +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
e1bff072fe
feat(ideal-image): new option disableInDev ( #6155 )
...
* feat(ideal-image): new option disableInDev
* Add docs
* Use import type
* More docs
2021-12-25 21:48:38 +08:00
John Reilly
a17deb6aa2
docs: remove mention of 'UA-' in gtag ( #6184 )
2021-12-24 17:21:31 +08:00
Sébastien Lorber
b393700a61
feat: async plugin creator functions ( #6166 )
2021-12-22 19:10:49 +01:00
Sébastien Lorber
f8a670966e
feat(core): async docusaurus.config.js creator function ( #6165 )
2021-12-22 17:03:01 +01:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +01:00
Joshua Chen
9078fd9fb2
docs: refactor & refine lifecycle API docs ( #5918 )
...
* docs: refactor & refine lifecycle API docs
* Fix links
* More writeup
* Rewording
* Rename path
* Use README
* Fix links
* Add redirects
* Do the same for latest version as well
* Move folder
* Fix broken link
2021-12-21 14:54:04 +08:00
Christopher Klint
d987c22996
feat(theme-classic): new configuration syntax for a simple footer ( #6132 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-12-20 19:45:27 +01:00
不郑
7e5f6bb805
feat(content-blog): support json feed ( #6126 )
...
* feat(content-blog): support json feed
* feat(content-blog): support json feed
* feat(content-blog): add json type to default feed options
* Refactors, docs, validation
* Fix test
* Ammend docs
* Add API doc
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-18 22:47:40 +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
ac88d979f1
refactor(ganalytics, gtag): move options out of themeConfig ( #5832 )
...
* refactor(ganalytics, gtag): move options out of themeConfig
* Forbid themeConfig options
* Add PR link
* Add key names to error message
* Fix?
* Doc updates
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-11-10 19:04:43 +08:00
Joshua Chen
ecce576bbc
docs: new APITable comp to render large tables ( #5891 )
2021-11-10 11:38:23 +01:00
Joshua Chen
4478dd9659
docs: make API sidebar partially autogenerated ( #5917 )
...
* docs: make API sidebar autogenerated
* fix paths
2021-11-10 14:08:50 +08: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
Devtato
1c024470e0
feat(content-blog): allow sorting posts in ascending order ( #5787 )
2021-11-09 18:25:43 +01:00
Devtato
41ef9daafd
feat(theme-classic): allow specifying width/height in logo ( #5770 )
...
* feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* Rework: add fields to logo object
* Fix
* More fixes
* Wrong width!
* No need for optional chaining
* Doc writeup
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-01 18:09:30 +08:00
William Poetra Yoga
ca9bd244aa
feat: allow user to specify deploymentBranch property in docusaurus.config.js ( #5841 )
...
* feat: allow user to specify deploymentBranch property in docusaurus.config.js
* docs: remove extra backtick
* docs: fix broken code block
2021-10-31 12:29:22 +08:00
Joshua Chen
7468136f88
docs: include navbar item type in the API table ( #5821 )
2021-10-29 18:11:07 +08:00
Robbie Averill
2e85848487
docs: Minor update to grammar in plugins overview page ( #5771 )
2021-10-27 13:06:05 +02:00
琚致远
1522c21a79
docs: update ssrTemplate ( #5774 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-27 11:41:27 +02:00
Joshua Chen
9ad6de2b85
feat(content-blog): new readingTime plugin option ( #5702 )
2021-10-21 15:26:10 +02:00
Sébastien Lorber
92002b6bd3
docs: rename docusaurus.config.js route + redirects cleanup ( #5755 )
2021-10-21 15:16:54 +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
ae3596df39
docs: add h4 into toc on certain pages ( #5728 )
2021-10-19 20:15:11 +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
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
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
29e06d0677
feat: make tags route path configurable ( #5545 )
2021-09-21 19:19:18 +02: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 | by \|
* Keep `code`
* Apply suggestions from code review
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-09-08 14:58:48 +03:00
