Help
Because sometimes I forget how to drive the software I'm running.
Todoโ
- Make all links absolute. ( e.g. /docs/sass/ai ) While training the documents with OpenAI, I noticed that some of the link references were not absolute.
- Create Github Actions to rebuild a Supabase index of the documents on every commit for the AI Assistant to use.
Logโ
Reposโ
Docusaurusโ
npm install
npm run start
npm run build
npm run serve
- 25/04/47 - added abcjs ^6.4.4 & react-piano ^3.1.3 for /Notes/Music/Notation
- 25/01/23 - 3.6.3 -> 3.7.0
- 24/24/02 - 3.6.1 -> 3.6.3
- 24/11/17 - upgrades ( 3.5.2 ๐๐ผ 3.6.1 ) all good ๐๐ผ
- 3.6 switched to Rust ๐ฆ rspack, SWC, Lightning CSS for faster builds
- 24/09/02 - upgrades ( 3.4.0 ๐๐ผ 3.5.2 ) all good ๐๐ผ
- 24/07/11 - upgrades ( 3.3.2 ๐๐ผ 3.4.0 ) all good ๐๐ผ
- 24/05/15 - upgrades ( 3.1.1 ๐๐ผ 3.3.2 ) all good ๐๐ผ
npm install @docusaurus/core@latest @docusaurus/plugin-content-blog@latest @docusaurus/preset-classic@latest @docusaurus/theme-mermaid@latest --save
24/01/28 - upgrades ( 3.0.1 ๐๐ผ 3.1.1 ) no overides. didn't have to reswizzle. Watch the letter casing, anchors, and relative URLs because the broken link checker has gotten more strict.
Watch the letter casing, anchors, and relative URLs because the broken link checker has gotten more strict.
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm outdated
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm list
daw-til-2@0.0.3 /Users/david/Sites/daw_til
โโโ @docusaurus/core@3.1.1
โโโ @docusaurus/plugin-content-blog@3.1.1
โโโ @docusaurus/preset-classic@3.1.1
โโโ @docusaurus/theme-mermaid@3.1.1
โโโ @mdx-js/mdx@3.0.0
โโโ @mdx-js/react@3.0.0
โโโ clsx@2.1.0
โโโ docusaurus-lunr-search@3.3.2
โโโ docusaurus-plugin-matomo@0.0.8
โโโ markprompt@0.1.7
โโโ plugin-image-zoom@1.1.0 (git+ssh://git@github.com/flexanalytics/plugin-image-zoom.git#8e1b866c79ed6d42cefc4c52f851f1dfd1d0c7de)
โโโ react-dom@18.2.0
โโโ react-player@2.14.1
โโโ react@18.2.0
23/12/12 - ๐ฅneeded a way to preface my posts
and wanted to change the default width so I swizzle
'd the BlogListPage
and BlogLayout
to widen it with col--9
.
npm run swizzle @docusaurus/theme-classic BlogLayout -- --eject
npm run swizzle @docusaurus/theme-classic BlogListPage -- --eject
line 15 of BlogLayout/index.js
<main
className={clsx('col', {
//'col--7': hasSidebar,
'col--9': hasSidebar,
'col--9 col--offset-1': !hasSidebar,
})}
...
</main>
line 33 of BlogListPage/index.js
<BlogLayout sidebar={sidebar}>
<h1>Posts</h1>
<p>...</p>
<hr/>
<br/>
<BlogPostItems items={items} />
<BlogListPaginator metadata={metadata} />
</BlogLayout>
23/11/27 - noticed my Lunr search was kicking JavaScript errors because I had swizzle
'd it in a previous version and needed to eject
it before the build. ( see github repo comment )
david@ovid๐ :~/sites/daw_til(mainโ) ยป npm run swizzle docusaurus-lunr-search SearchBar -- --eject
> daw-til-2@0.0.3 swizzle
> docusaurus swizzle docusaurus-lunr-search SearchBar --eject
[WARNING]
Swizzle action eject is unsafe to perform on SearchBar.
It is more likely to be affected by breaking changes in the future
If you want to swizzle it, use the `--danger` flag, or confirm that you understand the risks.
โ Do you really want to swizzle this unsafe internal component? โบ YES: I know what I am doing!
[SUCCESS]
Ejected SearchBar from docusaurus-lunr-search to
- "daw_til/src/theme/SearchBar/DocSearch.js"
- "daw_til/src/theme/SearchBar/HighlightSearchResults.jsx"
- "daw_til/src/theme/SearchBar/algolia.css"
- "daw_til/src/theme/SearchBar/index.jsx"
- "daw_til/src/theme/SearchBar/lunar-search.js"
- "daw_til/src/theme/SearchBar/styles.css"
- "daw_til/src/theme/SearchBar/templates.js"
- "daw_til/src/theme/SearchBar/utils.js"
Also noticed that since it now uses the default Algolia search elements which includes dark mode, I had to change the styling on it in /src/css/custom.css
.
[data-theme='dark'] .ds-dropdown-menu {
--ifm-background-color: #383a42;
border-color: #535763;
}
v3.0.0โ
23/11/12 - Docusaurus updated 2.4.3 ๐๐ผ 3.0.0 and React 17.0.2 ๐๐ผ 18.2.0
david@ovid๐ :~/sites/daw_til(mainโ) ยป npm outdated
Package Current Wanted Latest Location Depended by
@docusaurus/core 2.4.3 3.0.0 3.0.0 node_modules/@docusaurus/core daw_til
@docusaurus/plugin-content-blog 2.4.3 3.0.0 3.0.0 node_modules/@docusaurus/plugin-content-blog daw_til
@docusaurus/preset-classic 2.4.3 3.0.0 3.0.0 node_modules/@docusaurus/preset-classic daw_til
@docusaurus/theme-mermaid 2.4.3 3.0.0 3.0.0 node_modules/@docusaurus/theme-mermaid daw_til
@mdx-js/react 1.6.22 1.6.22 3.0.0 node_modules/@mdx-js/react daw_til
clsx 1.2.1 1.2.1 2.0.0 node_modules/clsx daw_til
docusaurus-lunr-search 3.0.0 3.3.0 3.3.0 node_modules/docusaurus-lunr-search daw_til
react 17.0.2 17.0.2 18.2.0 node_modules/react daw_til
react-dom 17.0.2 17.0.2 18.2.0 node_modules/react-dom daw_til
Docusaurus v3 now requires React 18 and Typescript 5
This introduced a bunch of breaking errors in the markdown formatting via the MDX formatting that are documented at:
Went in and cleaned up the markdown formatting - mostly the tags on links and indented code highlighting formatting.The build process was also failing due to some errors defining text wrapped in {}
๐๐ผ
Error: Failed to compile due to Webpack errors.
Error: Docusaurus server-side rendering could not render static page with path /docs/editors/git because of error: stash_number is not defined
Error: Docusaurus server-side rendering could not render static page with path /docs/lang/Rust because of error: url is not defined
Error: Docusaurus server-side rendering could not render static page with path /docs/shell/zsh because of error: bz2 is not defined
Error: Docusaurus server-side rendering could not render static page with path /lists/tweets_follow because of error: SoftwareHardwareDeveloperDesignerMakerInventor is not defined
at /Users/david/Sites/daw_til/node_modules/@docusaurus/core/lib/webpack/utils.js:207:24
at /Users/david/Sites/daw_til/node_modules/webpack/lib/MultiCompiler.js:554:14
at processQueueWorker (/Users/david/Sites/daw_til/node_modules/webpack/lib/MultiCompiler.js:491:6)
at process.processTicksAndRejections (node:internal/process/task_queues:77:11)
}
[INFO] Docusaurus version: 3.0.0
Node version: v18.12.1
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm list
daw-til-2@0.0.1 /Users/david/Sites/daw_til
โโโ @docusaurus/core@3.0.0
โโโ @docusaurus/plugin-content-blog@3.0.0
โโโ @docusaurus/preset-classic@3.0.0
โโโ @docusaurus/theme-mermaid@3.0.0
โโโ @mdx-js/mdx@3.0.0
โโโ @mdx-js/react@3.0.0
โโโ clsx@2.0.0
โโโ docusaurus-lunr-search@3.3.0
โโโ docusaurus-plugin-matomo@0.0.6
โโโ markprompt@0.1.7
โโโ plugin-image-zoom@1.1.0 (git+ssh://git@github.com/flexanalytics/plugin-image-zoom.git#8e1b866c79ed6d42cefc4c52f851f1dfd1d0c7de)
โโโ react-dom@18.2.0
โโโ react-player@2.13.0
โโโ react@18.2.0
23/09/23 - docusaurus updated - 2.4.1 ๐๐ผ 2.4.3 -> left react at 17 for now, but updated the react player to 2.13.
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm list
daw-til-2@0.0.1 /Users/david/Sites/daw_til
โโโ @docusaurus/core@2.4.3
โโโ @docusaurus/plugin-content-blog@2.4.3
โโโ @docusaurus/preset-classic@2.4.3
โโโ @docusaurus/theme-mermaid@2.4.3
โโโ @mdx-js/react@1.6.22
โโโ clsx@1.2.1
โโโ docusaurus-lunr-search@3.0.0
โโโ docusaurus-plugin-matomo@0.0.6
โโโ markprompt@0.1.7
โโโ plugin-image-zoom@1.1.0
โโโ react-dom@17.0.2
โโโ react-player@2.13.0
โโโ react@17.0.2
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm outdated
Package Current Wanted Latest Location Depended by
@mdx-js/react 1.6.22 1.6.22 2.3.0 node_modules/@mdx-js/react daw_til
clsx 1.2.1 1.2.1 2.0.0 node_modules/clsx daw_til
react 17.0.2 17.0.2 18.2.0 node_modules/react daw_til
react-dom 17.0.2 17.0.2 18.2.0 node_modules/react-dom daw_til
23/08/20 - added an image zoom plugin from https://github.com/flexanalytics/plugin-image-zoom because I didn't like linking to the images or having them constrained between the sidebars.
23/08/18 - updated notes structure to include some personal documents like /documents/family/mom/mom.md which is actually a directory outside of the site build on my computer. I ignore them in the builds and repos. The reason for this is that the more I use machine learning against my own documents, the more the information becomes valuable in vector searches. Because of that, I'm rethinking the way I even organize documents on my computer. For instance this doc when I'm talking to my mom on the phone about whatever, I can reference references I've previously made.
23/05/24 - docusaurus updated - 2.4.0 ๐๐ผ 2.4.1
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm list
daw-til-2@0.0.1 /Users/david/Sites/daw_til
โโโ @docusaurus/core@2.4.1
โโโ @docusaurus/plugin-content-blog@2.4.1
โโโ @docusaurus/preset-classic@2.4.1
โโโ @docusaurus/theme-mermaid@2.4.1
โโโ @mdx-js/react@1.6.22
โโโ clsx@1.2.1
โโโ docusaurus-lunr-search@2.3.2
โโโ docusaurus-plugin-matomo@0.0.6
โโโ markprompt@0.1.7
โโโ react-dom@17.0.2
โโโ react-player@2.12.0
โโโ react@17.0.2
23/05/09
- added react-player
- added markprompt
david@ovid๐ :~/sites/daw_til(mainโก) ยป npm list
daw-til-2@0.0.1 /Users/david/Sites/daw_til
โโโ @docusaurus/core@2.4.0
โโโ @docusaurus/plugin-content-blog@2.4.0
โโโ @docusaurus/preset-classic@2.4.0
โโโ @docusaurus/theme-mermaid@2.4.0
โโโ @mdx-js/react@1.6.22
โโโ clsx@1.2.1
โโโ docusaurus-lunr-search@2.3.2
โโโ docusaurus-plugin-matomo@0.0.6