hiroaki

This article organizes the main specifications and technical points from when I implemented a simple, client-side browser memo feature on a Docusaurus site using React and TypeScript.

This feature was later significantly extended in URL Sharing and UX Improvements.

Note that this article is a record from the time of implementation; for the continuously maintained procedure, see the technical documentation version.

1. Basic Features and Purpose​

To provide a feature that allows users to easily create and save text memos in their browser, with the content persisting on subsequent visits. The focus is on ease of use and responsiveness by having everything run entirely on the client-side (using the browser's localStorage) without any server-side processing.

This article outlines three main patterns for displaying icons or specific symbols in the navigation bar of a Docusaurus site.

This article is a record from when it was written. For the continuously maintained procedure, see the technical documentation version.

1. Displaying with Text and Symbols​

This is the most direct and simple method for displaying icons or symbols in navigation items. It is achieved by writing directly into the label property within the Docusaurus configuration file.

This article organizes the procedures and troubleshooting records from when I implemented a GitHub Action to detect new articles and post them to X as Twitter Cards.

This article is a record from when it was written. For the continuously maintained procedure, see the technical documentation version.

Feature: Detect new posts with GitHub Actions and post them to X as Twitter Cards.

This article organizes the steps I took to introduce Docker Compose for the local development environment of a Docusaurus project.

This article is a record from when it was written. For the continuously maintained procedure, see the technical documentation version.

Background:

To standardize the local development environment and simplify setup, I introduced Docker Compose to my Docusaurus (v3.8.0) project. Before this, I was running Node.js (v22.16.0) and pnpm (v10.11) by installing them directly on each developer's local machine.

This article organizes the steps and troubleshooting process I went through when setting up a site search feature using Algolia DocSearch.

This article is a record from when it was written. For the continuously maintained procedure, see the technical documentation version.

A Record of Implementing Algolia DocSearch in Docusaurus​

References:

• https://docusaurus.io/docs/search
• https://docsearch.algolia.com/docs/api/#indexname

Service Used:

• Algolia DocSearch

This article outlines the steps to set up the custom domain hkdocs.com, purchased from Value Domain, for this Docusaurus site hosted on Google Cloud Run.

This article is a record from when it was written. For the continuously maintained procedure, see the technical documentation version.

Prerequisites:

• Domain: hkdocs.com (already purchased from Value Domain)
• Hosting: Google Cloud Run
• Site Generator: Docusaurus