|
|
@@ -12,13 +12,13 @@ image: https://davidawindham.com/wp-content/themes/daw/img/opengraph_image.jpg
|
|
|
hide_table_of_contents: true
|
|
|
---
|
|
|
|
|
|
-Today I learned to upgrade this site to Docusaurus v3.0.0<sub>1</sub> and there were some breaking changes that had to be fixed<sub>2</sub>.
|
|
|
+Today I learned to upgrade this site to Docusaurus v3.0.0<sub>1</sub> and there were some breaking changes that had to be fixed<sub>2,3</sub>.
|
|
|
|
|
|
<!--truncate-->
|
|
|
|
|
|
-The biggest changes are that version 3 requires React 18 and Typescript 5. The majority of breaking changes for me were related to the MDX<sub>3</sub> upgrade from v1 to v3 and the subsequent markdown formatting. Indented code blocks, `{brackets}`, and `<hyperlinks>` were kicking errors which took a bit of manual labor to clean up.
|
|
|
+The biggest changes are that version 3 requires React 18 and Typescript 5. The majority of breaking changes for me were related to the MDX<sub>4</sub> upgrade from v1 to v3 and the subsequent markdown formatting. Indented code blocks, `{brackets}`, and `<hyperlinks>` were kicking errors which took a bit of manual labor to clean up.
|
|
|
|
|
|
-The Prism React Renderer was also upgraded to v2 so I switched the highlighting over to the OneDark theme. I made notes in the site log<sub>4</sub> and this is now the current list of packages for this site 👇🏼
|
|
|
+The Prism React Renderer was also upgraded to v2 so I switched the highlighting over to the OneDark theme. I made notes in the site log<sub>5</sub> and this is now the current list of packages for this site
|
|
|
|
|
|
```js
|
|
|
david@ovid🏛 :~/sites/daw_til(main⚡) » npm list
|
|
|
@@ -40,13 +40,13 @@ daw-til-2@0.0.1 /Users/david/Sites/daw_til
|
|
|
|
|
|
```
|
|
|
|
|
|
-I originally started this site as just a set of local markdown and text files. I migrated it to gitbook when I started storing the files in a repo and publishing them. I migrated it to Docusaurus when gitbook stopped being supported as an open source project. Nowadays, I use it constantly because it's easy to keep my docs and notes updated, in sync, and online.
|
|
|
+I use a couple add-ons: Lunr search, Matomo analytics, an image zoom, and MarkPrompt for Supabase indexing. I've customized a couple of things to make it visually blend into my primary domain. I originally started this site as just a set of local markdown and text files. I migrated it to gitbook when I started storing the files in a repo and publishing them. I migrated it to Docusaurus when gitbook stopped being supported as an open source project. Nowadays, I use it constantly because it's easy to keep my docs and notes updated, in sync, and online.
|
|
|
|
|
|
-One of the biggest assets about keeping all of the copy (data) of these site in plain markdown files is that it's relatively easy to dump them into a vector database to use against an AI model as compared to having various flavored markup interspersed into the database of a more traditional CMS. The default Docusaurus front-end theme now handles async rendering and at some point, I might consider integrating other data sources into it.
|
|
|
+One of the biggest assets about keeping all of the copy (data) of these site in plain markdown files is that it's relatively easy to dump them into a vector database to use against an AI model as compared to having various flavored markup interspersed into the database of a more traditional CMS. The default Docusaurus front-end theme now handles async rendering and at some point I'll start integrating some other data sources into it and customize the AI model/vector embeddings to make it more useful for me.
|
|
|
|
|
|
:::tip
|
|
|
|
|
|
-Big thanks 👏🏼 to Sébastien Lorber<sub>5</sub> who does 90+% of the work on it.
|
|
|
+Big thanks 👏🏼 to Sébastien Lorber<sub>6</sub> who does 90+% of the work on Docusaurus.
|
|
|
|
|
|
:::
|
|
|
|
|
|
@@ -54,8 +54,9 @@ Big thanks 👏🏼 to Sébastien Lorber<sub>5</sub> who does 90+% of the work o
|
|
|
|
|
|
---
|
|
|
|
|
|
-1. Preparing your site for Docusaurus v3 - https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3
|
|
|
-2. Docusaurus v3.0.0 Breaking Changes - https://github.com/facebook/docusaurus/discussions/9312
|
|
|
-3. MDX - https://mdxjs.com
|
|
|
-4. TIL _Help_ - [til/help](/help)
|
|
|
-5. Sébastien Lorber - https://github.com/slorber
|
|
|
+1. _Announcing Docusaurus 3.0_ - https://docusaurus.io/blog/releases/3.0
|
|
|
+2. _Preparing your site for Docusaurus v3_ - https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3
|
|
|
+3. _Docusaurus v3.0.0 Breaking Changes_ - https://github.com/facebook/docusaurus/discussions/9312
|
|
|
+4. MDX - https://mdxjs.com
|
|
|
+5. TIL _Help_ - [til/help](/help)
|
|
|
+6. Sébastien Lorber - https://github.com/slorber
|
