メインコンテンツまでスキップ

「software」タグのついた34記事

全てのタグを見る

Adding the CMS to an iPad home screen

Apple iPadOS では、任意のウェブページを独自の Safari インスタンスで動作するウェブアプリに変換し、ホーム画面に独自のアイコンとして追加できます。この機能を利用して、クラウドホスト型 CMS 用のアプリを作成できます。

Blog

ブログ機能を使用すると、タイムスタンプ付きの記事を作成できます。

Browser support

docStatic では、browserslist 設定を使用してサポートするブラウザのリストを定義できます。通常、ウェブサイトは最新のブラウザで問題なく動作します。

CLI

docStatic は、ウェブサイトの生成、提供、デプロイを支援する一連のスクリプトを提供しています。

Configuration

docStatic のサイト設定は docusaurus.config.ts ファイルで管理されます。このファイルを直接編集する方法については、Docusaurus ドキュメントの Configuration を参照してください。

Create a doc

docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。

Creating pages

ページは他の種類のコンテンツとは異なり、ショーケース、プレイグラウンド、サポートページなど、単独で完結するコンテンツとして設計されています。React コンポーネントと Markdown を含めることができます。ページにはサイドバーがありません。

Deployment

デフォルトでは、docStatic は GitHub Pages にデプロイされます。その他のオプションについては、Docusaurus ドキュメントの Deployment を参照してください。

Docs introduction

ドキュメント機能は、Markdown ファイルを階層形式で整理する方法を提供します。

Figures

Figures コンポーネントを使用すると、キャプション付きの画像をトピックに追加できます。ユーザーが図をクリックすると、ライトボックス内で最大倍率で表示されます。

Footnotes

Markdown には脚注を提供する拡張機能がありますが、その実装は一貫性がなく、コンテンツと番号が分離されてしまいます。たとえば:

Hosted CMS

docStatic の2つのコアコンポーネントのうちの1つが CMS です(もう1つは SSG)。これまで、おそらくコマンドラインから npm run dev または yarn dev で起動するローカルバージョンのみを使用してきたと思います。しかし、docStatic はホスト型 CMS を使用する2つの方法もサポートしています。

Installation

ようこそ!このガイドでは、docStaticを初めてセットアップする手順を説明します。

Internationalization

国際化(i18n)のサポートは静的サイトジェネレーターによって提供されています。詳細については、Docusaurusドキュメントのi18n - Introductionを参照してください。

Introduction

docStaticは、ライターと開発者の間の溝を埋め、ユーザーが愛するオンラインドキュメントの作成を支援するモダンなドキュメントプラットフォームです。

Introduction

Wiki sidebar generation and category index document conventions.

Markdown features

docStaticは、コンテンツ作成のメインフォーマットとしてMarkdownを使用しています。10分で学ぶこともできます。ただし、CMSがメタデータ、Markdown、Reactコンポーネントのための完全なリッチテキスト編集環境を提供しているため、必ずしも習得する必要はありません。

MCP Server Implementation Details

TinaCMS GraphQLエンドポイントを通じてAIアシスタントにdocStaticドキュメントへの構造化アクセスを提供するModel Context Protocol(MCP)サーバーです。

MCP Server Integration

docStaticには統合されたModel Context Protocol(MCP)サーバーが含まれており、AIアシスタントがドキュメントにアクセスして理解できるようにします。コンテンツの編集、検索、分析のためのインテリジェントなサポートを提供します。

Notifications

docStatic はワークフロー通知の送信に GitHub Actions を使用しています。レビューと翻訳の通知例は .github/workflows/ フォルダに含まれています。これらを有効にするには、GitHub での設定が必要です。また、独自のカスタム通知を開発するための出発点としても使用できます。

OpenAPI reference docs

docStatic は docusaurus-plugin-openapi-docs を使用して、OpenAPI 仕様から API リファレンスドキュメントを生成します。このプラグインは仕様ファイルを読み込み、docs/ ツリー内に一連の MDX ファイルを書き込みます。Docusaurus はそれらを通常のページとしてビルドします。

Prose linting with Vale

Valeは、設定可能なスタイルルールに照らしてドキュメントをチェックするコマンドラインの文章リンターです。MarkdownおよびMDXファイルとの統合性が高く、docStaticプロジェクトに自然に適合します。

Related Topics

Related Topics コンポーネントは、共通のタクソノミータグに基づいて関連コンテンツを自動的に提案します。現在のページのタグを分析し、類似したタグを持つ他のドキュメントを検索して、推奨リストとして表示します。

Search

デフォルトでは、docStaticはLunr検索を使用するよう設定されています。主な利点はコストゼロのソリューションであることです。主な欠点は、検索インデックス全体がユーザーのブラウザにダウンロードされるため、サイトが大きくなるほど遅くなることです。

Static assets

スタティックアセットとは、ビルド出力に直接コピーされるコード以外のファイルです。画像、スタイルシート、ファビコン、フォントなどが含まれます。

Style checking

ドキュメント・アズ・コードで作業するライターが最も恋しく思う機能の1つが、優れたスペル・文法・スタイルチェッカーです。デフォルトでは、スペルチェックはウェブブラウザや統合開発環境によって提供されます。シンプルなウェブサイトには十分かもしれませんが、より高度なものが必要な場合は専用の文法チェッカーが必要です。

Styling and layout

docStaticサイトはシングルページのReactアプリケーションです。Reactアプリのスタイリング方法と同じようにスタイルを設定できます。

Tabs

Tabs コンポーネントを使用すると、トピックにタブ付きコンテンツを追加できます。

Using Claude in this project

Claude CodeはAnthropicのAI搭載CLIです。このプロジェクトでは、特定のタスクの開発アシスタントとして使用されています。docStaticのアーキテクチャの設計や開発には使用されていません。

Using plugins

静的サイトジェネレーターのコアは独自の機能を提供しません。すべての機能は個々のプラグインに委ねられています。ドキュメント機能はdocsプラグイン、ブログ機能はblogプラグイン、個別ページはpagesプラグインによって提供されています。