Skip to content

Commit

Permalink
chore: docusaurus upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
mweststrate committed Mar 23, 2023
1 parent 0b72a6f commit 48a91b3
Show file tree
Hide file tree
Showing 14 changed files with 188 additions and 180 deletions.
2 changes: 1 addition & 1 deletion website/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: API overview
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

| Exported name | Description | Section |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/built-with.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Built with Immer
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

- [react-copy-write](https://github.com/aweary/react-copy-write) _Immutable state with a mutable API_
Expand Down
2 changes: 1 addition & 1 deletion website/docs/complex-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Classes
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

Plain objects (objects without a prototype), arrays, `Map`s and `Set`s are always drafted by Immer. Every other object must use the `immerable` symbol to mark itself as compatible with Immer. When one of these objects is mutated within a producer, its prototype is preserved between copies.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/current.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Current
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

Immer exposes a named export `current` that creates a copy of the current state of the draft. This can be very useful for debugging purposes (as those objects won't be Proxy objects and not be logged as such). Also, references to `current` can be safely leaked from a produce function. Put differently, `current` provides a snapshot of the current state of a draft.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: FAQ
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

## Q: How does Immer work?
Expand Down
4 changes: 2 additions & 2 deletions website/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ slug: /
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

<img src="/immer/img/immer-logo.svg" height="200px" align="right"/>
<img src="/immer/img/immer-logo.svg" style={{maxHeight:200}} align="right"/>

# Immer

Expand Down
2 changes: 1 addition & 1 deletion website/docs/map-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Map and Set
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

_⚠ Since version 6 support for `Map`s and `Set`s has to be enabled explicitly by calling [`enableMapSet()`](./installation.mdx#pick-your-immer-version) once when starting your application._
Expand Down
2 changes: 1 addition & 1 deletion website/docs/original.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Original
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

Immer exposes a named export `original` that will get the original object from the proxied instance inside `produce` (or return `undefined` for unproxied values). A good example of when this can be useful is when searching for nodes in a tree-like state using strict equality.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/pitfalls.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Pitfalls
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

### Performance tips
Expand Down
2 changes: 1 addition & 1 deletion website/docs/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: External resources
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

- Blog: [The Rise of Immer in React](https://www.netlify.com/blog/2018/09/12/the-rise-of-immer-in-react/)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Supporting immer
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

Immer currently has 350.000 dependents on GitHub, and has almost 10.000.000 downloads per month. However, only the first 2 days of development has been sponsored (by Mendix), and all the development and maintenance after that has been a labor of love.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/update-patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Update patterns
---

<center>
<div data-ea-publisher="immerjs" data-ea-type="image" class="horizontal bordered"></div>
<div data-ea-publisher="immerjs" data-ea-type="image" className="horizontal bordered"></div>
</center>

Working with immutable data, before Immer, used to mean learning all the immutable update patterns.
Expand Down
14 changes: 7 additions & 7 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
"write-translations": "docusaurus write-translations"
},
"dependencies": {
"@docusaurus/core": "2.2.0",
"@docusaurus/plugin-client-redirects": "2.2.0",
"@docusaurus/plugin-content-docs": "2.2.0",
"@docusaurus/plugin-google-analytics": "2.2.0",
"@docusaurus/plugin-google-gtag": "2.2.0",
"@docusaurus/plugin-sitemap": "2.2.0",
"@docusaurus/theme-classic": "2.2.0",
"@docusaurus/core": "^2.4.0",
"@docusaurus/plugin-client-redirects": "^2.4.0",
"@docusaurus/plugin-content-docs": "^2.4.0",
"@docusaurus/plugin-google-analytics": "^2.4.0",
"@docusaurus/plugin-google-gtag": "^2.4.0",
"@docusaurus/plugin-sitemap": "^2.4.0",
"@docusaurus/theme-classic": "^2.4.0",
"react": "^16.8.4",
"react-dom": "^16.8.4"
}
Expand Down
Loading

0 comments on commit 48a91b3

Please sign in to comment.