Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate Jest website to Docusaurus v2 #11021

Merged
merged 142 commits into from Feb 12, 2021
Merged
Show file tree
Hide file tree
Changes from 141 commits
Commits
Show all changes
142 commits
Select commit Hold shift + click to select a range
2145b36
initial migration
slorber Dec 1, 2020
d706009
temporarily disable all versions
slorber Dec 1, 2020
42163ef
MDX: fix Configuration.md
slorber Dec 1, 2020
3b52a9d
ignore website-v2 eslint gitignore
slorber Dec 1, 2020
ade283d
attempt to fix the homepage
slorber Dec 1, 2020
7616199
fix help page
slorber Dec 1, 2020
4f0ecbc
fix versions page
slorber Dec 1, 2020
93ec7c7
fix videos page
slorber Dec 1, 2020
d07a442
minor homepage details
slorber Dec 1, 2020
e69597e
temp disable the configuration page
slorber Dec 1, 2020
f78522b
remove blog post copy
slorber Dec 1, 2020
4636434
import css
slorber Dec 1, 2020
5abe568
backy backport of v1 component library
slorber Dec 1, 2020
968de50
backy backport of v1 component library
slorber Dec 1, 2020
3e52b5d
jest 2 proper Algolia index
slorber Dec 2, 2020
a125893
Rewire the landing page animation
slorber Dec 2, 2020
8031108
remove some legacy v1 CSS
slorber Dec 2, 2020
863f6a7
better backporting of v1 legacy CSS
slorber Dec 2, 2020
4e86553
improve landing buttons css
slorber Dec 2, 2020
c676930
apply mainContainerV1
slorber Dec 2, 2020
a2f8cc2
better integration of the legacy v1 comp library CSS
slorber Dec 2, 2020
2f45d1e
Add footer
slorber Dec 2, 2020
a4ec419
fix landing anim
slorber Dec 2, 2020
564f317
fix some broken links
slorber Dec 2, 2020
a04f2bf
better navbar
slorber Dec 2, 2020
0868699
Add sass plugin + social icons + improve homepage
slorber Dec 2, 2020
e0c2ea7
update v1 comp library classes
slorber Dec 2, 2020
b0068e3
fix twitter button
slorber Dec 2, 2020
df4b7c5
remove usage of customFields
slorber Dec 2, 2020
d2ec77e
remove annoying eslint warnings
slorber Dec 2, 2020
f753d5f
remove useless css/js
slorber Dec 2, 2020
4feecb0
rem some useless css
slorber Dec 2, 2020
44d3a74
Add better MarkdownBlock.js v1 support
slorber Dec 3, 2020
5998c83
fix docs broken links
slorber Dec 3, 2020
199a4bd
fix help page
slorber Dec 3, 2020
b50cc31
improve video page css
slorber Dec 3, 2020
af9932e
add some temp versions + cleanup /versions page useless CSS
slorber Dec 3, 2020
9353020
improve videos page
slorber Dec 3, 2020
6a80fbe
clean version page
slorber Dec 3, 2020
f5c1567
smaller landing buttons
slorber Dec 3, 2020
84bfa04
improve dark theme contrast
slorber Dec 3, 2020
c6fde84
remove some useless CSS
slorber Dec 3, 2020
9cd7a54
improve v1 CompLibrary backport
slorber Dec 3, 2020
f6f2899
revert config files
slorber Dec 3, 2020
d69bc8e
fix MDX escaping in Configuration.md docs
slorber Dec 3, 2020
50f4516
escape [
slorber Dec 3, 2020
7138750
Configuration.md fixes
slorber Dec 3, 2020
247408e
Fix Configuration.md escaping
slorber Dec 3, 2020
db5fab7
fix all broken links with .html extension
slorber Dec 3, 2020
896e0c8
add all versions
slorber Dec 3, 2020
6322a61
fix last broken link
slorber Dec 3, 2020
5761b5e
chore: update homepage and footer, add codeblocks light theme
Simek Dec 3, 2020
c83fab6
chore: small tweaks
Simek Dec 3, 2020
62349a1
chore: typo fix
Simek Dec 3, 2020
fc60e5b
chore: change dark code theme
Simek Dec 3, 2020
225cbc1
Merge pull request #1 from Simek/homepage-and-footer-tweaks
slorber Dec 4, 2020
f0429d6
chore: add basic custom prism themes
Simek Dec 4, 2020
00f204c
fix: fix Navbar logo and links positions and order
Simek Dec 4, 2020
40c8a90
fix: use correct key for background, add inserted to darkTheme
Simek Dec 4, 2020
82fbfc8
Merge pull request #7 from Simek/prism-custom-themes-init
slorber Dec 4, 2020
e6b5c23
Merge pull request #8 from Simek/fix-navbar-logo-and-order
slorber Dec 4, 2020
c7e9500
Split Jest doc in 2 sidebars
slorber Dec 7, 2020
7777210
Add Crowdin localisation support for v2
slorber Dec 8, 2020
5581b85
ignore scss files too
slorber Dec 8, 2020
2e1ca92
fix zh-Hans lang
slorber Dec 8, 2020
474d602
Add Crowdin integration
slorber Dec 9, 2020
5ed680c
fix netlify
slorber Dec 9, 2020
7e701f4
fix netlify
slorber Dec 9, 2020
a734316
fix netlify
slorber Dec 9, 2020
5936977
fix netlify
slorber Dec 9, 2020
e31cc17
fix netlify
slorber Dec 9, 2020
c3791d0
fix netlify
slorber Dec 9, 2020
40d42dc
fix netlify
slorber Dec 9, 2020
443c54d
Merge pull request #11 from jest-website-migration/add-i18n
slorber Dec 9, 2020
2dd390c
remove useless language mapping comments
slorber Dec 9, 2020
8a5d177
Add temporary locale dropdown
slorber Dec 9, 2020
6515993
Merge branch 'docusaurus-2' into split-sidebars
slorber Dec 9, 2020
5ba8821
Merge pull request #10 from jest-website-migration/split-sidebars
slorber Dec 9, 2020
4e34eb9
temporarily remove some languages
slorber Dec 9, 2020
120ce52
temp fix for locale dropdown
slorber Dec 9, 2020
0c7df81
temp fix for locale dropdown
slorber Dec 9, 2020
ddf5fad
disable Jest site markdown pages
slorber Dec 9, 2020
37ec25c
Add algolia docsearch CSS theming
slorber Dec 9, 2020
dbd5d74
temp dropdown fix
slorber Dec 9, 2020
f60f058
Add CNAME for GH domain
slorber Dec 10, 2020
0577685
re-enable all Jest locales
slorber Dec 10, 2020
aac2aaa
fix features alignment issue, see https://github.com/jest-website-mig…
slorber Dec 11, 2020
5557bcc
replace v1 usage of <AUTOGENERATED_TABLE_OF_CONTENTS> by v2 TOCInline…
slorber Dec 11, 2020
c241aa7
Add real locale dropdown to navbar
slorber Dec 14, 2020
8b7fd2b
update canary version
slorber Dec 14, 2020
04a58ce
handle translated markdown block case
slorber Dec 15, 2020
3f19d6d
remove unused versions for Docusaurus v2
slorber Dec 15, 2020
758549a
disable fixCrowdinTranslations temporarily as it may not be useful an…
slorber Dec 15, 2020
1f4d06e
Add yarn write-translations to Netlify process
slorber Dec 15, 2020
09bfd3e
remove code transformations from older versions
slorber Dec 15, 2020
790cd6c
remove original_id v1 useless frontmatter
slorber Dec 15, 2020
ddf6195
add basic redirects plugin setup
slorber Dec 15, 2020
bd039b3
Merge branch 'master' into docusaurus-2
slorber Jan 19, 2021
3273950
use @crowdin/cli official npm package
slorber Jan 19, 2021
f6a3809
Upgrade to latest canary
slorber Jan 20, 2021
4aaea17
Prepare Jest v2 website
slorber Jan 20, 2021
6a414f7
fix lint rules + prettier
slorber Jan 21, 2021
3753be4
fix lint rules + prettier
slorber Jan 21, 2021
43d5e4a
Fix FB copyright headers
slorber Jan 21, 2021
2e0b219
Add netlify redirects
slorber Jan 21, 2021
3eed61a
test commit
slorber Jan 21, 2021
5c3deda
test
slorber Jan 21, 2021
c1c35ba
Merge pull request #12 from jest-website-migration/config-netlify
slorber Jan 21, 2021
75df92e
fix jest blog post layout
slorber Jan 21, 2021
2bc5132
fix prettier config
slorber Jan 21, 2021
907c4c9
Add pwa support
slorber Jan 21, 2021
bb9ab32
add missing PWA manifest
slorber Jan 21, 2021
ac3a4a8
fix manifest icon error
slorber Jan 21, 2021
3308db3
Merge pull request #13 from jest-website-migration/docu-pwa
slorber Jan 21, 2021
be4ccb7
Add crowdin script logging
slorber Jan 21, 2021
765045e
Update docs/JestObjectAPI.md
slorber Jan 22, 2021
146a975
Update .gitignore
slorber Jan 22, 2021
a4f31f9
Update docs/TutorialAsync.md
slorber Jan 22, 2021
fc1e778
handle code review
slorber Jan 22, 2021
f0fd9fd
migrate v1 class comps to fn comps
slorber Jan 22, 2021
abde9a5
restore deleted settings file
slorber Jan 22, 2021
debfcd6
restore README.md
slorber Jan 22, 2021
ceb4468
add theme color constant
slorber Jan 22, 2021
f596aa9
add theme color constant
slorber Jan 22, 2021
666cade
extract i18n config in separate file
slorber Jan 22, 2021
dd54da7
fix crowdin script
slorber Jan 22, 2021
ce204ea
removed useless docusaurus script as per review comment
slorber Jan 27, 2021
3a866bb
upgrade docusaurus
slorber Feb 4, 2021
d403e81
fix css-loader issues in docusaurus sass plugin after deps upgrade
slorber Feb 4, 2021
21c88d2
configure jest 404 redirects localized on Netlify
slorber Feb 4, 2021
5d963a7
Add archived versions
slorber Feb 4, 2021
e10c682
Add localized edit urls
slorber Feb 5, 2021
fbdf95a
Remove CircleCi config that deploys to GH pages
slorber Feb 5, 2021
b7a7629
fix RN tutorial doc link
slorber Feb 5, 2021
3c0804d
complete website/README.md
slorber Feb 5, 2021
6ae0b75
use yarn patch for docusaurus sass problem
slorber Feb 10, 2021
fd34cd0
Update website/package.json
slorber Feb 11, 2021
9fa5ce4
Merge remote-tracking branch 'upstream/jest-website-v2' into docusaur…
slorber Feb 11, 2021
8e2e769
update yarn lock
slorber Feb 11, 2021
7460798
remove 26.0-5 docs
slorber Feb 12, 2021
f13694e
rename 26.6 to 26.x
slorber Feb 12, 2021
ee538c9
fix link
slorber Feb 12, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 0 additions & 16 deletions .circleci/config.yml
Expand Up @@ -83,20 +83,6 @@ jobs:
- store_test_results:
path: reports/junit

test-or-deploy-website:
working_directory: ~/jest
executor: node/default
resource_class: large
steps:
- checkout
- node/install:
lts: true
install-npm: false
- node/install-packages: *install
- run:
name: Test or Deploy Jest Website
command: ./.circleci/website.sh

# Workflows enables us to run multiple jobs in parallel
workflows:
version: 2
Expand All @@ -107,5 +93,3 @@ workflows:
- test-node-14
- test-node-15 # current
- test-jest-jasmine
- test-or-deploy-website:
filters: *filter-ignore-gh-pages
35 changes: 0 additions & 35 deletions .circleci/website.sh

This file was deleted.

2 changes: 1 addition & 1 deletion .eslintignore
Expand Up @@ -4,10 +4,10 @@ bin/
flow-typed/**
packages/*/build/**
packages/jest-diff/src/cleanupSemantic.ts
website/.docusaurus
website/blog
website/build
website/node_modules
website/i18n/*.js
website/translated_docs
website/static
!.eslintrc.js
8 changes: 8 additions & 0 deletions .eslintrc.js
Expand Up @@ -153,6 +153,14 @@ module.exports = {
'sort-keys': 'off',
},
},
{
files: ['website/**/*'],
rules: {
'import/order': 'off',
'import/sort-keys': 'off',
'sort-keys': 'off',
},
},
{
files: ['examples/**/*'],
rules: {
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Expand Up @@ -20,11 +20,11 @@
/packages/*/coverage/
/packages/*/node_modules/

/website/.docusaurus
/website/build
/website/backers.json
/website/node_modules
/website/yarn.lock
/website/translated_docs
/website/i18n/*

/reports/*
Expand All @@ -46,3 +46,5 @@ package-lock.json
!**/.yarn/sdks
!**/.yarn/versions
**/.pnp.*

crowdin-cli.jar
92 changes: 45 additions & 47 deletions crowdin.yaml
@@ -1,50 +1,48 @@
project_identifier_env: CROWDIN_JEST_PROJECT_ID
api_key_env: CROWDIN_JEST_API_KEY
base_path: './'
#
# Your Crowdin credentials
#
project_id: '428892'
api_token_env: 'CROWDIN_PERSONAL_TOKEN'

base_path: '.'
base_url: 'https://api.crowdin.com'
preserve_hierarchy: true

# See Yaml anchors: https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/
languages_mapping: &languages_mapping
locale:
'es-ES': 'es-ES'
'ja': 'ja'
'pt-BR': 'pt-BR'
'ro': 'ro'
'ru': 'ru'
'uk': 'uk'
'zh-CN': 'zh-Hans'

#
# Files configuration
# see https://support.crowdin.com/configuration-file/
#
files:
- source: '/docs/*.md'
translation: '/website/translated_docs/%locale%/%original_file_name%'
languages_mapping: &anchor
locale:
'af': 'af'
'ar': 'ar'
'bs-BA': 'bs-BA'
'ca': 'ca'
'cs': 'cs'
'da': 'da'
'de': 'de'
'el': 'el'
'es-ES': 'es-ES'
'fa': 'fa-IR'
'fi': 'fi'
'fr': 'fr'
'he': 'he'
'hu': 'hu'
'id': 'id-ID'
'it': 'it'
'ja': 'ja'
'ko': 'ko'
'mr': 'mr-IN'
'nl': 'nl'
'no': 'no-NO'
'pl': 'pl'
'pt-BR': 'pt-BR'
'pt-PT': 'pt-PT'
'ro': 'ro'
'ru': 'ru'
'sk': 'sk-SK'
'sr': 'sr'
'sv-SE': 'sv-SE'
'tr': 'tr'
'uk': 'uk'
'vi': 'vi'
'zh-CN': 'zh-Hans'
'zh-TW': 'zh-Hant'
- source: '/website/versioned_docs/**/*.md'
translation: '/website/translated_docs/%locale%/**/%original_file_name%'
languages_mapping: *anchor
- source: '/website/i18n/en.json'
translation: '/website/i18n/%locale%.json'
languages_mapping: *anchor
[
{
'source': '/website/i18n/en/**/*',
'translation': '/website/i18n/%locale%/**/%original_file_name%',
'languages_mapping': *languages_mapping,
},
{
'source': '/docs/**/*',
'translation': '/website/i18n/%locale%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
'languages_mapping': *languages_mapping,
},
{
'source': '/website/versioned_docs/**/*',
'translation': '/website/i18n/%locale%/docusaurus-plugin-content-docs/**/%original_file_name%',
'languages_mapping': *languages_mapping,
},
{
'source': '/website/blog/**/*',
'translation': '/website/i18n/%locale%/docusaurus-plugin-content-blog/**/%original_file_name%',
'languages_mapping': *languages_mapping,
},
]
4 changes: 3 additions & 1 deletion docs/CLI.md
Expand Up @@ -100,7 +100,9 @@ jest --update-snapshot --detectOpenHandles

_Note: CLI options take precedence over values from the [Configuration](Configuration.md)._

<AUTOGENERATED_TABLE_OF_CONTENTS>
import TOCInline from "@theme/TOCInline"

<TOCInline toc={toc[toc.length - 1].children}/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

toc[toc.length - 1].children is somewhat weird. I don't have any suggestion for an improvement, but this seems magical and somewhat manual at the same time 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That may be clearer if you read this doc :)

https://v2.docusaurus.io/docs/next/markdown-features/inline-toc/#custom-table-of-contents

Basically, you can pass whatever you want from this component. You could have written toc={toc} , but we don't want the full page TOC, we just want to list the children's of the last item's level-2 heading (reference).

see how the right toc and the inlined toc content is slightly different

image


---

Expand Down