mkdocs-section-index: Move titles to mkdocs.yml

Archmonger · Archmonger · commit 8f58f8c836f3 · 2023-06-20T17:23:28.000-07:00
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,3 +6,4 @@ linkcheckmd
 mkdocs-spellcheck[all]
 mkdocs-git-authors-plugin
 mkdocs-minify-plugin
+mkdocs-section-index
diff --git a/docs/src/about/code.md b/docs/src/about/code.md
@@ -1,3 +0,0 @@
----
-title: Contributing Code 🚧
----
diff --git a/docs/src/about/community.md b/docs/src/about/community.md
@@ -1,3 +0,0 @@
----
-title: Community 🚧
----
diff --git a/docs/src/about/docs.md b/docs/src/about/docs.md
@@ -1,3 +0,0 @@
----
-title: Contributing Documentation 🚧
----
diff --git a/docs/src/about/running-tests.md b/docs/src/about/running-tests.md
@@ -1,3 +0,0 @@
----
-title: Running Tests 🚧
----
diff --git a/docs/src/learn/add-react-to-an-existing-project.md b/docs/src/learn/add-react-to-an-existing-project.md
@@ -1,6 +1,3 @@
----
-title: Add React to an Existing Project 🚫
----
 
 !!! warning "In Progress"
 
diff --git a/docs/src/learn/choosing-the-state-structure.md b/docs/src/learn/choosing-the-state-structure.md
@@ -1,6 +1,3 @@
----
-title: Choosing the State Structure 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/communicate-data-between-server-and-client.md b/docs/src/learn/communicate-data-between-server-and-client.md
@@ -1,3 +0,0 @@
----
-title: Communicating Data Between Server and Client 🚧
----
diff --git a/docs/src/learn/conditional-rendering.md b/docs/src/learn/conditional-rendering.md
@@ -1,6 +1,3 @@
----
-title: Conditional Rendering 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/convert-between-vdom-and-html.md b/docs/src/learn/convert-between-vdom-and-html.md
@@ -1,3 +0,0 @@
----
-title: Convert Between VDOM and HTML 🚧
----
diff --git a/docs/src/learn/creating-backends.md b/docs/src/learn/creating-backends.md
@@ -1,3 +0,0 @@
----
-title: Creating Backends 🚧
----
diff --git a/docs/src/learn/creating-html-tags.md b/docs/src/learn/creating-html-tags.md
@@ -1,3 +0,0 @@
----
-title: Creating HTML Tags 🚧
----
diff --git a/docs/src/learn/creating-vdom-event-handlers.md b/docs/src/learn/creating-vdom-event-handlers.md
@@ -1,3 +0,0 @@
----
-title: Creating VDOM Event Handlers 🚧
----
diff --git a/docs/src/learn/editor-setup.md b/docs/src/learn/editor-setup.md
@@ -1,6 +1,3 @@
----
-title: Editor Setup 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/extracting-state-logic-into-a-reducer.md b/docs/src/learn/extracting-state-logic-into-a-reducer.md
@@ -1,6 +1,3 @@
----
-title: Extracting State Logic into a Reducer 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/importing-and-exporting-components.md b/docs/src/learn/importing-and-exporting-components.md
@@ -1,6 +1,3 @@
----
-title: Importing and Exporting Components 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/keeping-components-pure.md b/docs/src/learn/keeping-components-pure.md
@@ -1,6 +1,3 @@
----
-title: Keeping Components Pure 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/lifecycle-of-reactive-effects.md b/docs/src/learn/lifecycle-of-reactive-effects.md
@@ -1,6 +1,3 @@
----
-title: "Lifecycle of Reactive Effects 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/manipulating-the-dom-with-refs.md b/docs/src/learn/manipulating-the-dom-with-refs.md
@@ -1,6 +1,3 @@
----
-title: "Manipulating the DOM with Refs 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/manually-register-a-client.md b/docs/src/learn/manually-register-a-client.md
@@ -1,3 +0,0 @@
----
-title: Manually Register a Client 🚧
----
diff --git a/docs/src/learn/passing-data-deeply-with-context.md b/docs/src/learn/passing-data-deeply-with-context.md
@@ -1,6 +1,3 @@
----
-title: Passing Data Deeply with Context 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/passing-props-to-a-component.md b/docs/src/learn/passing-props-to-a-component.md
@@ -1,6 +1,3 @@
----
-title: Passing Props to a Component 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/preserving-and-resetting-state.md b/docs/src/learn/preserving-and-resetting-state.md
@@ -1,6 +1,3 @@
----
-title: Preserving and Resetting State 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/python-in-psx-with-curly-braces.md b/docs/src/learn/python-in-psx-with-curly-braces.md
@@ -1,6 +1,3 @@
----
-title: Python in PSX with Curly Braces 🚫
----
 
 !!! warning "In Progress"
 
diff --git a/docs/src/learn/queueing-a-series-of-state-updates.md b/docs/src/learn/queueing-a-series-of-state-updates.md
@@ -1,6 +1,3 @@
----
-title: Queueing a Series of State Updates 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/quick-start.md b/docs/src/learn/quick-start.md
@@ -1,7 +1,3 @@
----
-title: "Get Started"
----
-
 ## Overview
 
 <p class="intro" markdown>
diff --git a/docs/src/learn/react-developer-tools.md b/docs/src/learn/react-developer-tools.md
@@ -1,6 +1,3 @@
----
-title: React Developer Tools 🚫
----
 
 !!! warning "In Progress"
 
diff --git a/docs/src/learn/reacting-to-input-with-state.md b/docs/src/learn/reacting-to-input-with-state.md
@@ -1,6 +1,3 @@
----
-title: Reacting to Input with State 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/referencing-values-with-refs.md b/docs/src/learn/referencing-values-with-refs.md
@@ -1,6 +1,3 @@
----
-title: "Referencing Values with Refs 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/removing-effect-dependencies.md b/docs/src/learn/removing-effect-dependencies.md
@@ -1,6 +1,3 @@
----
-title: "Removing Effect Dependencies 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/render-and-commit.md b/docs/src/learn/render-and-commit.md
@@ -1,6 +1,3 @@
----
-title: Render and Commit 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/rendering-lists.md b/docs/src/learn/rendering-lists.md
@@ -1,6 +1,3 @@
----
-title: Rendering Lists 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/responding-to-events.md b/docs/src/learn/responding-to-events.md
@@ -1,6 +1,3 @@
----
-title: Responding to Events 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/reusing-logic-with-custom-hooks.md b/docs/src/learn/reusing-logic-with-custom-hooks.md
@@ -1,6 +1,3 @@
----
-title: "Reusing Logic with Custom Hooks 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/scaling-up-with-reducer-and-context.md b/docs/src/learn/scaling-up-with-reducer-and-context.md
@@ -1,6 +1,3 @@
----
-title: Scaling Up with Reducer and Context 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/separating-events-from-effects.md b/docs/src/learn/separating-events-from-effects.md
@@ -1,6 +1,3 @@
----
-title: "Separating Events from Effects 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/sharing-state-between-components.md b/docs/src/learn/sharing-state-between-components.md
@@ -1,6 +1,3 @@
----
-title: Sharing State Between Components 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/start-a-new-react-project.md b/docs/src/learn/start-a-new-react-project.md
@@ -1,6 +1,3 @@
----
-title: Start a New React Project
----
 
 ## Overview
 
diff --git a/docs/src/learn/state-a-components-memory.md b/docs/src/learn/state-a-components-memory.md
@@ -1,6 +1,3 @@
----
-title: "State: A Component's Memory 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/state-as-a-snapshot.md b/docs/src/learn/state-as-a-snapshot.md
@@ -1,6 +1,3 @@
----
-title: State as a Snapshot 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/synchronizing-with-effects.md b/docs/src/learn/synchronizing-with-effects.md
@@ -1,6 +1,3 @@
----
-title: "Synchronizing with Effects 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/thinking-in-react.md b/docs/src/learn/thinking-in-react.md
@@ -1,6 +1,3 @@
----
-title: Thinking in React
----
 
 ## Overview
 
@@ -86,7 +83,7 @@ You can either build "top down" by starting with building the components higher
     # TODO
     ```
 
-(If this code looks intimidating, go through the [Quick Start](../learn/get-started.md) first!)
+(If this code looks intimidating, go through the [Quick Start](../learn/quick-start.md) first!)
 
 After building your components, you'll have a library of reusable components that render your data model. Because this is a static app, the components will only return non-interactive HTML. The component at the top of the hierarchy (`filterable_product_table`) will take your data model as a prop. This is called _one-way data flow_ because the data flows down from the top-level component to the ones at the bottom of the tree.
 
diff --git a/docs/src/learn/tutorial-material-ui.md b/docs/src/learn/tutorial-material-ui.md
@@ -1,6 +1,3 @@
----
-title: "Tutorial: Material UI 🚫"
----
 
 
 !!! warning "In Progress"
diff --git a/docs/src/learn/tutorial-react-bootstrap.md b/docs/src/learn/tutorial-react-bootstrap.md
@@ -1,6 +1,3 @@
----
-title: "Tutorial: React Bootstrap 🚫"
----
 
 !!! warning "In Progress"
 
diff --git a/docs/src/learn/tutorial-tic-tac-toe.md b/docs/src/learn/tutorial-tic-tac-toe.md
@@ -1,6 +1,3 @@
----
-title: "Tutorial: Tic-Tac-Toe 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/updating-arrays-in-state.md b/docs/src/learn/updating-arrays-in-state.md
@@ -1,6 +1,3 @@
----
-title: Updating Arrays in State 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/updating-objects-in-state.md b/docs/src/learn/updating-objects-in-state.md
@@ -1,6 +1,3 @@
----
-title: Updating Objects in State 🚧
----
 
 ## Overview
 
diff --git a/docs/src/learn/vdom-mutations.md b/docs/src/learn/vdom-mutations.md
@@ -1,3 +0,0 @@
----
-title: VDOM Mutations 🚧
----
diff --git a/docs/src/learn/writing-markup-with-psx.md b/docs/src/learn/writing-markup-with-psx.md
@@ -1,6 +1,3 @@
----
-title: Writing Markup with PSX 🚫
----
 
 !!! warning "In Progress"
 
diff --git a/docs/src/learn/you-might-not-need-an-effect.md b/docs/src/learn/you-might-not-need-an-effect.md
@@ -1,6 +1,3 @@
----
-title: "You Might Not Need an Effect 🚧"
----
 
 ## Overview
 
diff --git a/docs/src/learn/your-first-component.md b/docs/src/learn/your-first-component.md
@@ -1,6 +1,3 @@
----
-title: Your First Component 🚧
----
 
 ## Overview
 
diff --git a/docs/src/reference/client-api.md b/docs/src/reference/client-api.md
@@ -1,3 +0,0 @@
----
-title: Client API 🚧
----
diff --git a/docs/src/reference/common-props.md b/docs/src/reference/common-props.md
@@ -1,6 +1,3 @@
----
-title: Common Props 🚧
----
 
 #### Props
 
diff --git a/docs/src/reference/django.md b/docs/src/reference/django.md
@@ -1,3 +0,0 @@
----
-title: Django 🚧
----
diff --git a/docs/src/reference/fastapi.md b/docs/src/reference/fastapi.md
@@ -1,3 +0,0 @@
----
-title: FastAPI 🚧
----
diff --git a/docs/src/reference/flask.md b/docs/src/reference/flask.md
@@ -1,3 +0,0 @@
----
-title: Flask 🚧
----
diff --git a/docs/src/reference/jupyter.md b/docs/src/reference/jupyter.md
@@ -1,3 +0,0 @@
----
-title: Jupyter 🚧
----
diff --git a/docs/src/reference/plotly-dash.md b/docs/src/reference/plotly-dash.md
@@ -1,3 +0,0 @@
----
-title: Plotly Dash 🚧
----
diff --git a/docs/src/reference/protocol-structure.md b/docs/src/reference/protocol-structure.md
@@ -1,3 +0,0 @@
----
-title: Protocol Structure 🚧
----
diff --git a/docs/src/reference/sanic.md b/docs/src/reference/sanic.md
@@ -1,3 +0,0 @@
----
-title: Sanic 🚧
----
diff --git a/docs/src/reference/starlette.md b/docs/src/reference/starlette.md
@@ -1,3 +0,0 @@
----
-title: Starlette 🚧
----
diff --git a/docs/src/reference/tornado.md b/docs/src/reference/tornado.md
@@ -1,3 +0,0 @@
----
-title: Tornado 🚧
----
diff --git a/docs/src/reference/usage.md b/docs/src/reference/usage.md
@@ -1,3 +0,0 @@
----
-title: Usage 🚧
----
diff --git a/docs/src/reference/use-callback.md b/docs/src/reference/use-callback.md
@@ -1,6 +1,3 @@
----
-title: Use Callback 🚧
----
 
 ## Overview
 
diff --git a/docs/src/reference/use-connection.md b/docs/src/reference/use-connection.md
@@ -1,3 +0,0 @@
----
-title: Use Connection 🚧
----
diff --git a/docs/src/reference/use-context.md b/docs/src/reference/use-context.md
diff --git a/docs/src/reference/use-debug-value.md b/docs/src/reference/use-debug-value.md
diff --git a/docs/src/reference/use-deferred-value.md b/docs/src/reference/use-deferred-value.md
diff --git a/docs/src/reference/use-effect.md b/docs/src/reference/use-effect.md
diff --git a/docs/src/reference/use-id.md b/docs/src/reference/use-id.md
diff --git a/docs/src/reference/use-imperative-handle.md b/docs/src/reference/use-imperative-handle.md
diff --git a/docs/src/reference/use-insertion-effect.md b/docs/src/reference/use-insertion-effect.md
diff --git a/docs/src/reference/use-layout-effect.md b/docs/src/reference/use-layout-effect.md
diff --git a/docs/src/reference/use-location.md b/docs/src/reference/use-location.md
diff --git a/docs/src/reference/use-memo.md b/docs/src/reference/use-memo.md
diff --git a/docs/src/reference/use-reducer.md b/docs/src/reference/use-reducer.md
diff --git a/docs/src/reference/use-ref.md b/docs/src/reference/use-ref.md
diff --git a/docs/src/reference/use-scope.md b/docs/src/reference/use-scope.md
diff --git a/docs/src/reference/use-state.md b/docs/src/reference/use-state.md
diff --git a/docs/src/reference/use-sync-external-store.md b/docs/src/reference/use-sync-external-store.md
diff --git a/docs/src/reference/use-transition.md b/docs/src/reference/use-transition.md
diff --git a/mkdocs.yml b/mkdocs.yml
