13d07eff13
docs: refer to deployed branch as deployment rather than target ( #5903 )
2021-11-08 14:15:28 +08:00
0fc7adfba9
docs: document global variables in MDX scope ( #5900 )
...
* Adding a note for how to access frontMatter within pages
* Move documentation
Co-authored-by: cd rubin <github@earthling.za.net>
2021-11-07 23:16:04 +08:00
caa9d923a6
docs: add example for Github Pages deployment; rewrite deployment section ( #4409 )
...
* docs: Minor copy changes + increment numbered list
* docs: Add alternative github pages deploy workflow
* docs: Add separate PR workflow for alternative gh-pages deploy example
* docs: Minor `gh-pages` deploy config improvements
Improve some comments and clarifies the file path beyond file name alone for each config file.
Additionally removes the workflow path triggers as in practice these being updated shouldn't be triggering a re-run of the workflow again (assuming deterministic build from same input results in same output).
If there is a need for such a manual trigger of the workflow is probably a better approach. Performing a build because workflow comments were modified only would be pointless for example.
* docs: Clarify `gh-pages` deploy config some more
* chore: PR Feedback - Remove inline documentation
Upstream doesn't see value including help comments for a copy/paste config under the basis that it adds friction to the viewer seeking guidance how to perform something they don't know.
* chore: PR Feedback - Rephrase instruction
MatanBobi requested a rephrase during review.
* Rewrite
* Fixes
* Fix!
* Format
* Fix indentation
* Improvements
* Minor fixes
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-07 16:29:08 +08:00
effa46e930
docs: update GitHub deployment instructions ( #5888 )
...
* SSH is required for GitHub deployment now
Matches what is listed in the default README.md of a new Docusaurus site
* Minimum node version required is 14.x
documentation.yml as written fails to run because the minimum node version for Docusaurus is 14.x
* Add link to default URL of locally-served site
* Correct deployment workflow
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-07 13:29:56 +08:00
0aba31de7b
docs: fix wrong code sample in docusaurus-core ( #5881 )
2021-11-05 22:57:59 +08:00
95ed6e1349
docs: '5 minutes tutorial' -> '5-minute tutorial' ( #5876 )
...
* docs: fix a few instances where '5 minute tutorial' is written as '5 minutes tutorial'
* add hyphen
2021-11-05 10:58:57 +08:00
fa6d15b35f
feat(core): Add React ErrorBoundary component + theme default boundaries ( #3104 )
...
Co-authored-by: Paden Clayton <paden.clayton@monkedia.com>
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-11-04 16:07:32 +01:00
4922764095
docs: create SEO documentation page ( #5759 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-04 12:57:27 +01:00
1e7f688598
docs: remove duplicated appId property ( #5869 )
2021-11-04 13:51:01 +08:00
9f861dfb96
docs: fix a typo in using-themes.md ( #5868 )
2021-11-04 12:40:36 +08:00
d7581b38fd
docs: Fix a typo in versioning.md ( #5852 )
2021-11-02 14:23:06 +08:00
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
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
9247332334
feat(preset-classic): guard against unknown keys in options ( #5831 )
2021-10-30 12:39:12 +08:00
adbc02ea38
feat(search-algolia): algolia externalUrl regex to navigate with window.href ( #5795 )
2021-10-29 19:53:47 +02:00
dc5a0b7068
docs: elaborate on the usage of MDX plugins ( #5766 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-29 16:31:00 +02:00
fc32194cbb
docs: fix lint issue ( #5826 )
2021-10-29 16:21:42 +02:00
b5b2c18118
docs: Update Drone Deployment docs ( #5801 )
2021-10-29 15:41:12 +02:00
a210e938e4
chore: fix Crowdin again ( #5825 )
2021-10-29 15:37:45 +02:00
157b41caee
chore: replace doc sample .pdf file by .xlsx to solve Crowdin issue ( #5823 )
2021-10-29 14:46:21 +02:00
7468136f88
docs: include navbar item type in the API table ( #5821 )
2021-10-29 18:11:07 +08:00
ab127e528d
doc: fix typo in "create a doc" ( #5818 )
...
* Update docs-create-doc.mdx
* Update docs-create-doc.mdx
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-29 14:48:36 +08:00
1ce6253cc1
chore: require Node 14 ( #5812 )
2021-10-28 17:11:25 +02:00
ca5d70d7fb
docs: use "npx create-docusaurus" for init ( #5797 )
2021-10-27 14:46:25 +02:00
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
d4114c77fc
docs: fix link for apply to DocSearch program ( #5784 )
2021-10-25 16:03:26 +03:00
9ad6de2b85
feat(content-blog): new readingTime plugin option ( #5702 )
2021-10-21 15:26:10 +02:00
92002b6bd3
docs: rename docusaurus.config.js route + redirects cleanup ( #5755 )
2021-10-21 15:16:54 +02:00
2398943c17
feat(core): write-heading-ids options maintainCasing, overwrite ( #5740 )
2021-10-21 12:33:52 +02:00
3127f12654
feat(content-docs): new front matter options to customize pagination ( #5705 )
2021-10-21 12:27:57 +02:00
1e0a32924b
docs(v2): Fix typo in using-plugins.md ( #5750 )
2021-10-20 15:38:25 +02:00
ae3596df39
docs: add h4 into toc on certain pages ( #5728 )
2021-10-19 20:15:11 +02:00
647c8a2918
docs: fix npm init command with options ( #5712 )
...
* docs: fix npm init command with options
* Update test-release.sh
2021-10-15 16:31:15 +03:00
92104c7c3b
feat: make Translate children optional ( #5683 )
...
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-10-14 18:39:41 +02:00
c8739ec28e
polish(theme-classic): guard against potential definition mistakes in Tabs ( #5674 )
2021-10-14 15:47:03 +02:00
d6b4eeb358
feat(theme-classic): make first tab the default tab ( #5647 )
...
* Initial work
* Little doc fix
* Doc fix
2021-10-07 17:06:17 +02:00
7b64e85dc3
docs: Algolia plugin must be enabled before crawling the site ( #5658 )
2021-10-07 17:00:47 +02:00
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
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
7f7b858cd4
refactor: make all Props defined as interface + readonly ( #5636 )
...
* Initial work
* Fix
2021-10-05 19:04:24 +02:00
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
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
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
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
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
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
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
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
29e06d0677
feat: make tags route path configurable ( #5545 )
2021-09-21 19:19:18 +02:00
Joshua Chen