Commit Graph

26 Commits

Author SHA1 Message Date
Frazer Smith 49bacb9620
chore: update jest repo organisation in urls (#14413) 2023-08-15 15:00:44 +02:00
Tom Mrazauskas 8219820a87
chore(lint): use `jest/prefer-to-be` rule (#13369) 2022-10-03 14:07:11 +02:00
Ava Li 21b32abc5f
chore(docs): updated docs with jsdom changes (#12831) 2022-05-10 18:54:00 +02:00
Joshua Chen 7b857d5dba
docs: move codeblock title to props & use line highlight (#11991) 2021-10-24 10:01:50 +02:00
Ricky d6e5ddb0c3
Rename all links to main (#11856) 2021-09-08 16:01:42 -04:00
Simen Bekkhus 6eeadab63b stop wrapping markdown (#6299) 2018-05-27 01:16:17 +01:00
Simen Bekkhus 9b40311dec Format markdown files with Prettier (#4853)
* Format md files with prettier

* Format even more markdown

* Fix escaping of .

* Don't use prettier on readme.md

* Use prettier@1.8.1

* Prettify moar files

* Remove redundant prettier options from vscode settings

* Format with prettier 1.8.2
2017-11-10 19:33:02 +00:00
Eric Nakagawa 172c0b28d5 Update website to use Docusaurus (#4536)
* Adding a clean copy of Docusaurus

Updating sidebar

Modifying files into Docusaurus format

Slight header logo CSS change

Ignore translated files and build directory

Proper file locations for Docusaurus

Move blog files to Docusaurus preferred location, modified crowdin to output /docs to /translated_pages, updated siteConfig.js

Eslinting Docusaurus files

Ignoring website/blog pages

Linter fixes

* Updating Circle config to remove website test

* Updating Circle config to auto-deploy website

* Add @deltice's config changes before website build, skip yarn build step

* Switch crowdin branch to master

* Updating siteconfig to @deltice's file

* Test crowdin branch

* Switching Crowdin to master

* Uses yarn to install, run, and deploy

* Feedback fixes

Switch to use process.env.VAR for algolia key

Switching crowdin upload/download to use yarn

Circle CI fix

Adding a delay to crowdin

Fixing prettier errors

Updating crowdin command in circle ci config

Path fix

* Upgrading docusaurus to 1.0.0a40, adds an RSS/Atom feed

* Update Docusaurus version

* Updated footer to reflect current footer. Updated footer logo.

* Fixes Edit this doc link, removes node_modules from .gitignore

* Move .gitignore rules to top level

* Updating license file in siteConfig to MIT, added new Docusaurus beta to package.json

* Lint fix

* Editing siteConfig.js to account for /docs not living in /docs/en
2017-10-11 09:00:06 +01:00
Eric Nakagawa 62d29f2636 Add Localization Support for Jest Website (#3416)
* Adds a link to CrowdIn project from language drop down

* Adds comments to generated files

* Modify Circle CI to manually download crowdin cli

* Doc build process only renders pages that are enabled in languages.js

* Added a favicon.ico

* Merging TutorialAsync.md

Adding Bosnian, enabling Espanol

Using ENV variables
2017-05-02 21:33:30 +01:00
Eric Nakagawa 27b53ca4fe Revert Localization effort (#3404)
* Revert Localization effort

* Reran prettier

* Revert dangerfile.js

* Reverting README.md

* Moving line alphabetical order
2017-04-27 21:40:58 -07:00
Eric Nakagawa 144327dc59 Add Localization Support for Jest Website (#3337)
* Merging TutorialAsync.md

* Copied all docs from current master branch

Localization Cleanup

Added a link to CrowdIn in language drop down

Further cleanup, moved CrowdIn API key to environment

HeaderNav fix

* Fixes prettier.js and other CI issues
Added comments to generated files
Worked out additional lint issues, added i18n files to ignore

* Update .eslintignore
2017-04-25 18:02:29 +01:00
Hannan Ali 5ab8e2826e ESLint support for documentation (#3047)
* add markdown plugin in eslint

* add lint-docs build step

* lint JavaScript file

* final lint-docs command

* lint ExpectAPI

* lint GettingStarted.md

* lint GlobalAPI

* lint GlobalAPI

* lint JestObjectAPI

* lint Webpack.md

* lint UsingMatchers.md in docs

* lint TutorialReactNative.md in docs

* lint TutorialReact.md in docs

* lint docs file

* add lint-docs to test-ci script

* add lint-docs script to test & test-ci

* turn off more rules to lint-docs in package.json

* remove lint-docs from test and test-ci

* add lint-docs to test script in package.json

* remove lint-docs script from circle.yml

* add lint-docs script to test-ci in package.json

* rename js codeblock with json appropriately

* remove unnecessary log files

* remove lint-docs from test-ci

test script already includes lint-docs,
it'll be reduntant to do the same for more than one node versions

* remove error.log file

* use eslintrc-docs.json for overriding

* remove eslint comments from docs

Removing eslint comments from docs and moving them to
top level in .eslintrc-docs.json

* add lint-docs in correct order to test-ci and test
2017-03-04 08:46:48 +00:00
Héctor Ramos 27a8077258 Revamped Jest Docs and Website
New look and feel. Updated all tutorials, docs, guides with latest best practices.

* Cleaned up API Reference docs (#2422)
* Reorganized Sidebar Navigation
* New Introduction Section (#2425)
* Simplified Getting Started introduction
* Break up API Reference into multiple docs, separate from Guides (#2388)
* Support is now Help (#2370)
* Add "Snapshot Testing", "Testing Asynchronous Code" & "Setup and Teardown" docs (#2419, #2406)
* Create Jest user showcase (#2369)
* New blog post announcing refreshed documentation (#2522)
* Truncate blog posts in blog index
* New homepage hero (#2662)
* New mobile nav (#2664)
* Add standard FB Open Source Footer (#2660)
* Add RedirectLayout to prevent broken links (#2700)
* Refreshed Homepage and Colors across site (#2699)
* Deploy Jest website via CircleCI
2017-01-27 09:40:05 -08:00
Kenneth Skovhus d9a426ba93 Documentation: migration guide (#1837) 2016-10-03 15:49:21 +09:00
cpojer fed449c226 Changelog, get rid of `describe` in docs, fix thrown error printing, update new default error messages. 2016-08-31 19:02:14 +01:00
Christoph Pojer 3bbf32a239 New defaults for Jest. (#1511) 2016-08-30 11:07:15 +01:00
Christoph Pojer c5ba031287 Better flow types for jest-runtime. (#1222) 2016-07-01 12:02:45 +09:00
Raymond Zhou 07168315fd Rename `tutorial` folder to `jquery`.
Summary:
For https://github.com/facebook/jest/pull/1094#issuecomment-223046579
Closes https://github.com/facebook/jest/pull/1098

Differential Revision: D3372687

fbshipit-source-id: 6d969ac09d4f16e5c94261f96410e303dda55d25
2016-06-01 11:45:51 -07:00
cpojer 40db699e8b Update eslint rules and clean up code.
Summary:We spend too much time reviewing minor nits and it increases turnaround time. This updates the eslint config to error on a few stylistic things and it is now aligned with the Jest code style.

This was also a good change (or well, I was forced :P ) to clean up the last of the cruft of the codebase :)
Closes https://github.com/facebook/jest/pull/892

Reviewed By: vjeux

Differential Revision: D3178752

fb-gh-sync-id: 7d1b759dffeca9374ecab39f7f031cf0da6832e3
fbshipit-source-id: 7d1b759dffeca9374ecab39f7f031cf0da6832e3
2016-04-14 20:31:28 -07:00
cpojer 1e41587778 Fix babel polyfill integration, add async tests and documentation.
Summary: Closes https://github.com/facebook/jest/pull/767

Differential Revision: D3014818

fb-gh-sync-id: 7da53151ddbe12fb2d9c28ed341503d07617e5cf
shipit-source-id: 7da53151ddbe12fb2d9c28ed341503d07617e5cf
2016-03-04 16:24:56 -08:00
cpojer 81d6697617 New documentation and updated website and examples.
Summary:This gets Jest ready for 0.9.0.

What's new?
* Slightly refreshed look, based on the Relay website.
* New summary of what Jest is on the website.
* New Getting Started guide, with babel support and key feature explanation.
* Added a troubleshooting section.
* Updated all examples in the documentation.
* Added all new APIs to the API docs, updated everything to use `jest.fn()` instead of `jest.genMockFn()`.
* Removed the webpack alias and coffeescript guides. Neither of them are really supported or useful at this point. We can bring back a guide later on proper webpack integration if someone in the community takes this on. The webpack-alias feature is handled by the `moduleNameMapper` API.
* Added a link to the `Failed to get metadata` error in Jest.

See http://cpojer.github.io/jest/ for a preview.

In a follow-up I'll add a section on async testing for Promises and some more info about automocking.
Closes https://github.com/facebook/jest/pull/763

Reviewed By: yungsters

Differential Revision: D3005361

fb-gh-sync-id: f8e634cf4a311764f311f8b5849781b53975e686
shipit-source-id: f8e634cf4a311764f311f8b5849781b53975e686
2016-03-03 14:20:34 -08:00
Christoph Pojer a11ef01382 Import jest docs from open source
Reviewed By: voideanvalue

Differential Revision: D2573262

fb-gh-sync-id: 2cdca4715e9c6cafdfb69f819f05c9518d270af8
2015-10-23 11:11:35 -07:00
cpojer 73ccfff402 Remove docs so the FB sync will work again. 2015-10-23 11:11:01 -07:00
Michael Chan f81fcbfdee docs: fix typo
"innter" -> "inner"
"we'd it expect" -> "we'd expect"

@zpoa so sorry to have put this in the wrong place. this makes much more sense. thanks for the correction :)

originally #284
2015-03-02 21:07:20 -08:00
jeffmo 87440084e1 Fix typo in TutorialjQuery.md 2014-05-16 10:24:51 -07:00
jeffmo 88a94d5d1b FIRST! 2014-05-14 09:42:01 -07:00