Commit graph

692 commits

Author SHA1 Message Date
Joshua Chen
3889e89380
fix(theme-classic): make React elements in pre render correctly (#6177)
* fix(theme-classic): make React elements in pre render correctly

* Properly fix

* Use MDX

* Add docs

* Better comment

* Update code-block-tests.mdx
2021-12-25 15:27:29 +08:00
Rishi Raj Jain
6716548b87
docs: add Layer0 to deployment guide (#6188) 2021-12-25 10:17:33 +08:00
John Reilly
a17deb6aa2
docs: remove mention of 'UA-' in gtag (#6184) 2021-12-24 17:21:31 +08:00
Pranab Das
e4f9ab072c
chore: upgrade rehype-katex and katex stylesheet for website (#6172)
* chore: Update rehype-katex and katex stylesheet for doc website

* Reformat

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-23 14:24:56 +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
5dcfa8fa23
docs: fix import module name of theme/Admonition (#6164) 2021-12-22 22:11:11 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +01:00
Joshua Chen
287292497d
test: fix async tests resolved in random order (#6143) 2021-12-21 18:51:56 +08: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
Joshua Chen
cb4265253a
feat(theme-classic): standalone Admonition component (#5848) 2021-12-20 17:51:19 +01:00
Yangshun Tay
faef753730
docs: mention admonition quirks with Prettier (#6135)
* docs: mention admonition quirks with Prettier

* Update markdown-features-admonitions.mdx

* Update markdown-features-admonitions.mdx

* Update markdown-features-admonitions.mdx
2021-12-20 12:14:50 +08:00
Himanshu
c0a99786b3
docs: elaborate on "docs-only" and "blog-only" (#6131)
* rephrased documentation

* Rewording

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-20 09:29:43 +08: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
18cb13d6cc
docs: refactor docs sidebar doc (#6130)
* docs: refactor docs sidebar doc

* Edits
2021-12-19 19:08:59 +08:00
Joshua Chen
ac7c7670cd
docs: refactor styling/theming docs (#6129)
* docs: refactor styling/theming docs

* Add classic-typescript to README
2021-12-19 10:38:58 +08: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
Joshua Chen
06bd44c693
feat(theme-common): stable classname for code blocks (#6125)
* feat(theme-common): stable classname for code blocks

* Remove extra lines

* Fix styles

* Remove line
2021-12-18 13:32:30 +08:00
Drylozu
fa3926e2a1
feat(theme-classic): allow passing additional attributes to tab headings (#6082)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-17 18:23:50 +01:00
Joshua Chen
f84eb073e7
docs: mention that SEO through front matter is better than head tag (#6112) 2021-12-17 12:29:51 +01:00
Joshua Chen
7db4884853
refactor(website): make deploy preview open next version docs by default (#6120)
* refactor(website): make deploy preview open next version docs by default

* Fix links
2021-12-17 11:00:12 +08:00
Joshua Chen
fcaa94695d
fix(core): do not apply theme-init alias to user component (#5983)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-12-03 18:59:45 +01:00
Fernando Maia
b366ba5603
feat: shorthands for themes/plugins/presets configuration (#5930)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-12-03 18:23:12 +01: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
Joshua Chen
373eda272e
docs(deployment): add cost-benefit analysis with different options (#6026) 2021-12-02 18:29:13 +01:00
Rey
78537aab2a
docs: update Netlify url config option in deployment instructions (#6019)
Netlify now provides `*.netlify.app` subdomains instead of `*.netlify.com` for project sites. Redirects still work, so the current config option isn't wrong but it's a good idea to keep the docs up to date.
2021-11-27 13:34:32 +08:00
Can Olcer
8359ff36cd
docs: improve algolia integration instructions (#6008)
* docs: improve algolia integration instructions

The current version makes it look like you need to install `@docusaurus/theme-search-algolia` on top the classic version to work, but it already works with the classic version. Adding `@docusaurus/theme-search-algolia` on top leads to errors.

* Still document installation

* Do not make separate paragraph

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-25 20:03:32 +08:00
Martin Šošić
b1a4f3913d
docs: improve explanation for url config in GH Pages (#6006) 2021-11-25 16:50:34 +08:00
Alexey Pyltsyn
3551212d50
docs: update links to default translations dir (#5979) 2021-11-20 18:44:28 +01:00
Alexey Pyltsyn
63bd6b9025
refactor: define own translations in other themes (#5849)
Co-authored-by: Armano <armano2@users.noreply.github.com>
2021-11-20 16:35:27 +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
Morooka Kotaro
284cdabb0a
docs: fix BrowserOnly return statement (#5953)
* docs: fix BrowserOnly return statement

* Update docusaurus-core.md

* Fix version docs

* prettier

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-15 21:27:45 +08:00
Afshin Mehrabani
54d0755493
feat(create-docusaurus): allow using local folder as template (#3458)
* feat(docusaurus-init): search the local ./templates folder during doc init

* Add docs

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-15 12:37:22 +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
William Poetra Yoga
f5732e7589
feat: allow GIT_USER env var to be unset if SSH is used (#5840)
* feat: allow GIT_USER env var to be unset if SSH is used

* fix: packages/docusaurus/src/commands/deploy.ts

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* 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

* docs: fix i18n routes to feature requests (#5843)

* docs: fix i18n routes to feature requests

* Add redirect rules

* feat: allow GIT_USER env var to be unset if SSH is used

* fix: packages/docusaurus/src/commands/deploy.ts

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* fix: avoid escaping hyphen in regex

* Refactor

* Update deployment.mdx

* Make SSH higher priority

* Only infer but not override

* Add tests

* Fix tests

* Fix

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-10 18:51:12 +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
Joshua Chen
13d07eff13
docs: refer to deployed branch as deployment rather than target (#5903) 2021-11-08 14:15:28 +08:00
Joshua Chen
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
Brennan Kinney
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
Ivan Boothe
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
Matthijs Groen
0aba31de7b
docs: fix wrong code sample in docusaurus-core (#5881) 2021-11-05 22:57:59 +08:00
Molly White
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
Paden Clayton
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
Devtato
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
Dmitriy Fishman
9f861dfb96
docs: fix a typo in using-themes.md (#5868) 2021-11-04 12:40:36 +08:00