From 6ee74bc107764a0995d250d676f0fae6444794a6 Mon Sep 17 00:00:00 2001 From: Mostafa Ahangarha Date: Sat, 30 Sep 2023 19:52:56 +0330 Subject: [PATCH] Include sub headings for documentation in README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index b8f0deb9b..3506f1ba1 100644 --- a/README.md +++ b/README.md @@ -40,14 +40,41 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by= ## Documentation - [Get started](docs/get-started.md) + - [Use with Shakapacker](docs/get-started.md#use-with-shakapacker) + - [Component name](docs/get-started.md#component-name) + - [File naming](docs/get-started.md#file-naming) + - [Typescript support](docs/get-started.md#typescript-support) + - [Test component](docs/get-started.md#test-component) + - [Use with Asset Pipeline](docs/get-started.md#use-with-asset-pipeline) + - [Custom JSX Transformer](docs/get-started.md#custom-jsx-transformer) + - [Transform Plugin Options](docs/get-started.md#transform-plugin-options) + - [React.js versions](docs/get-started.md#reactjs-versions) - [View Helper](docs/view-helper.md) + - [Custom View Helper](docs/view-helper.md#custom-view-helper) - [UJS](docs/ujs.md) + - [Mounting & Unmounting](docs/ujs.md#mounting--unmounting) + - [Event Handling](docs/ujs.md#event-handling) + - [`getConstructor`](docs/ujs.md#getconstructor) - [Server-Side Rendering](docs/server-side-rendering.md) + - [Configuration](docs/server-side-rendering.md#configuration) + - [JavaScript State](docs/server-side-rendering.md#javascript-state) + - [Custom Server Renderer](docs/server-side-rendering.md#custom-server-renderer) - [Controller Actions](docs/controller-actions.md) - [Component Generator](docs/component-generator.md) + - [Use with JBuilder](docs/component-generator.md#use-with-jbuilder) + - [Camelize Props](docs/component-generator.md#camelize-props) + - [Changing Component Templates](docs/component-generator.md#changing-component-templates) - [Upgrading](docs/upgrading.md) + - [2.7 to 3.0](docs/upgrading.md#27-to-30) + - [2.3 to 2.4](docs/upgrading.md#23-to-24) - [Migrating from `react-rails` to `react_on_rails`](docs/migrating-from-react-rails-to-react_on_rails.md) + - [Why migrate?](docs/migrating-from-react-rails-to-react_on_rails.md#why-migrate) + - [Steps to migrate](docs/migrating-from-react-rails-to-react_on_rails.md#steps-to-migrate) - [Common Errors](docs/common-errors.md) + - [Getting warning for `Can't resolve 'react-dom/client'` in React < 18](docs/common-errors.md#getting-warning-for-cant-resolve-react-domclient-in-react--18) + - [Undefined Set](docs/common-errors.md#undefined-set) + - [Using TheRubyRacer](docs/common-errors.md#using-therubyracer) + - [HMR](docs/common-errors.md#hmr) After reading this README file, additional information about React-Rails can be found in the Wiki page: