Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Debug your apps, find hydration errors, trace your network and more in your react-router app with these devtools

License

NotificationsYou must be signed in to change notification settings

forge-42/react-router-devtools

Repository files navigation

This template is designed to support a flexible content structure using.md and.mdx files organized into folders. It enables deeply nested sections and subsections, making it easy to manage complex documentation with a clear and scalable hierarchy.

The project is built using the@forge-42/base-stack and leverages thecontent-collections.

Note:We added a fewFIXME comments in the codebase as notes to you. These simply mark small places where we expect you to make changes. Nothing major — it should only take you 2 minutes to go through them.

Documentation Template Structure Overview

app/

This folder contains React Router v7 web application folders and files, including components and UI primitives for the documentation site’s interface, internal hooks and utilities, and the tailwind.css file for styling.

resources/

This folder contains all the resources used by the documentation site, such as SVG icons, fonts, and other assets.

content/

This folder contains .md and .mdx files that hold your documentation content. Below is the recommended structure to follow.

An example of a valid content/ folder structure for organizing your package documentation:

content/├── _index.mdx├── 01-changelog.mdx├── 02-introduction.mdx├── 03-overview.mdx├── 04-getting-started/│   ├── index.md│   ├── 01-installation.mdx│   ├── 02-quick-start.mdx│   └── 03-project-setup.mdx└── 05-core-features/    ├── index.md    ├── 01-authentication.mdx    ├── 02-authorization.mdx    ├── 03-data-management/    │   ├── index.md    │   ├── 01-fetching-data.mdx    │   └── 02-caching-strategies.mdx    └── 04-ui-components/        ├── index.md        ├── 01-buttons.mdx        └── 02-modals.mdx
  • Top-level .mdx files (like 01-changelog.mdx) are allowed, but we recommend placing them in order before the sections, as shown in the example.

  • Sections (like 04-getting-started, 05-core-features) are subfolders inside thecontent folder.

  • Subsections (like 03-data-management, 04-ui-components) are nested folders within sections. Filenames inside them should start with01-*.mdx.

  • Each section or subsection should include anindex.md file, which defines its sidebar title.

Example of the valid**/*.mdx file:

---title: "Introduction to Forge42 Base Stack"summary: "Overview of the Stack"description: "Get started with the Forge42 Base Stack — a modern web app starter template designed for speed, scalability, and developer experience."---## What is Forge42 Base Stack?The Forge42 Base Stack is a full-featured web application starter template. It combines modern tools and technologies like **Remix**, **Tailwind CSS**, **TypeScript**, **Vitest**, and **React Aria Components** to help you build accessible and scalable web apps quickly.This documentation will guide you through setting up the project, understanding its structure, and customizing it for your needs.## InstallationTo get started with the base stack, simply clone the repository and install dependencies:```bashnpx degit forge42/base-stack my-appcd my-appnpm install

Example of the valid**/*.md file:

---title: Getting Started---

Getting started

  1. Fork the repository

  2. Install the dependencies:

pnpm install
  1. Read through the README.md files in the project to understand our decisions.

  2. Runpnpm run generate:docs script

  3. Start the development server:

pnpm run dev
  1. After you see that everything works with the current content inside thecontent folder, remove those files and add your own

  2. Happy coding!

About

Debug your apps, find hydration errors, trace your network and more in your react-router app with these devtools

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors26

Languages


[8]ページ先頭

©2009-2025 Movatter.jp