Skip to content

Commit f2a6ece

Browse files
authored
Move and update the editors index/setup page (#11956)
- Move `/get-started/editors` to `/tools/editors` - Remove the setup instructions - These were moved to the individual editor pages in #11955. - Update the page with a new index of editor support, with a section for local editors, online editors, and other/unsupported editors. Resolves #11333 Contributes to #11911 **Staged:** https://flutter-docs-prod--pr11956-feat-11333-yuqts3as.web.app/tools/editors
1 parent 0429795 commit f2a6ece

File tree

6 files changed

+91
-175
lines changed

6 files changed

+91
-175
lines changed

firebase.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
{ "source": "/formatting", "destination": "/tools/formatting", "type": 301 },
6060
{ "source": "/gestures", "destination": "/ui/advanced/gestures", "type": 301 },
6161
{ "source": "/hot-reload", "destination": "/tools/hot-reload", "type": 301 },
62-
{ "source": "/ide-setup", "destination": "/get-started/editor", "type": 301 },
62+
{ "source": "/ide-setup", "destination": "/tools/editors", "type": 301 },
6363
{ "source": "/images/catalog-widget-placeholder.png", "destination": "/assets/images/docs/catalog-widget-placeholder.png", "type": 301 },
6464
{ "source": "/inspector", "destination": "/tools/devtools/inspector", "type": 301 },
6565
{ "source": "/intellij-ide", "destination": "/tools/android-studio", "type": 301 },
@@ -121,6 +121,7 @@
121121
{ "source": "/deployment/fastlane-cd", "destination": "/deployment/cd#fastlane", "type": 301 },
122122
{ "source": "/get-started", "destination": "/get-started/install", "type": 301 },
123123
{ "source": "/get-started/codelab-web", "destination": "/get-started/codelab", "type": 301 },
124+
{ "source": "/get-started/editor", "destination": "/tools/editors", "type": 301 },
124125
{ "source": "/get-started/flutter-for", "destination": "/get-started/learn-flutter", "type": 301 },
125126
{ "source": "/get-started/flutter-for/ios-devs", "destination": "/get-started/flutter-for/swiftui-devs", "type": 301 },
126127
{ "source": "/get-started/fwe/:rest*", "destination": "/get-started/fundamentals/:rest*", "type": 301 },
@@ -706,7 +707,7 @@
706707
{ "source": "/to/develop-packages", "destination": "/packages-and-plugins/developing-packages", "type": 301 },
707708
{ "source": "/to/develop-plugins", "destination": "/packages-and-plugins/developing-packages#plugin", "type": 301 },
708709
{ "source": "/to/edit-plugins", "destination": "/packages-and-plugins/developing-packages#edit-plugin-package", "type": 301 },
709-
{ "source": "/to/editor-setup", "destination": "/get-started/editor", "type": 301 },
710+
{ "source": "/to/editor-setup", "destination": "/tools/editors", "type": 301 },
710711
{ "source": "/to/engine-artifacts", "destination": "https://github.com/flutter/flutter/blob/main/docs/tool/Engine-artifacts.md", "type": 301 },
711712
{ "source": "/to/engine-rbe", "destination": "https://github.com/flutter/engine/blob/main/docs/rbe/rbe.md", "type": 301 },
712713
{ "source": "/to/engine-tool", "destination": "https://github.com/flutter/engine/blob/main/tools/engine_tool/README.md", "type": 301 },

src/content/get-started/editor.md

Lines changed: 0 additions & 170 deletions
This file was deleted.

src/content/packages-and-plugins/developing-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1065,7 +1065,7 @@ PENDING
10651065
[iOS]: /platform-integration/ios/c-interop
10661066
[macOS]: /platform-integration/macos/c-interop
10671067
[`fluro`]: {{site.pub}}/packages/fluro
1068-
[Flutter editor]: /get-started/editor
1068+
[Flutter editor]: /tools/editors
10691069
[Flutter Favorites]: {{site.pub}}/flutter/favorites
10701070
[Flutter Favorites program]: /packages-and-plugins/favorites
10711071
[Gradle Documentation]: https://docs.gradle.org/current/userguide/tutorial_using_tasks.html

src/content/resources/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ of the many editors that support [editing Dart][].
178178
[Android Studio]: {{site.android-dev}}/studio
179179
[Android Studio/IntelliJ]: /tools/android-studio
180180
[editing Dart]: {{site.dart-site}}/tools
181-
[editor configuration]: /get-started/editor
181+
[editor configuration]: /tools/editors
182182
[IntelliJ IDEA]: https://www.jetbrains.com/idea/
183183
[VS Code]: https://code.visualstudio.com/
184184

src/content/tools/editors.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Flutter editor support
3+
short-title: Editors
4+
description: >-
5+
Editor support for Dart and Flutter.
6+
toc: false
7+
---
8+
9+
You can build apps with Flutter using any text editor or
10+
integrated development environment (IDE)
11+
combined with Flutter's command-line tools.
12+
13+
The Flutter team recommends using an editor that supports
14+
a Flutter extension or plugin, like VS Code and Android Studio.
15+
These plugins provide code completion, syntax highlighting,
16+
widget editing assists, debug support, and much more.
17+
18+
## Local editors
19+
20+
The Flutter team supports plugins for VS Code, Android Studio, and IntelliJ.
21+
The plugins provide extensive development and debugging support as well as
22+
deep integrations with the [Dart analyzer][] and [Dart and Flutter DevTools][].
23+
24+
<div class="card-grid">
25+
<a class="card outlined-card" href="/tools/vs-code">
26+
<div class="card-header">
27+
<span class="card-title">Visual Studio Code</span>
28+
</div>
29+
<div class="card-content">
30+
<p>Develop and debug Flutter apps in a streamlined and customizable code editor.</p>
31+
</div>
32+
</a>
33+
<a class="card outlined-card" href="/tools/android-studio">
34+
<div class="card-header">
35+
<span class="card-title">Android Studio and IntelliJ</span>
36+
</div>
37+
<div class="card-content">
38+
<p>Develop and debug Flutter apps in an IDE with rich language support and integrated tooling.</p>
39+
</div>
40+
</a>
41+
</div>
42+
43+
[Dart analyzer]: {{site.dart-site}}/tools/analysis
44+
[Dart and Flutter DevTools]: /tools/devtools
45+
46+
## Online editors
47+
48+
You can quickly try Flutter online without any local setup
49+
with one of the following editors.
50+
51+
<div class="card-grid">
52+
<a class="card outlined-card" href="{{site.dartpad}}" target="_blank">
53+
<div class="card-header">
54+
<span class="card-title">
55+
<span>DartPad</span>
56+
<span class="material-symbols" aria-hidden="true" style="font-size: 1rem;">open_in_new</span>
57+
</span>
58+
</div>
59+
<div class="card-content">
60+
<p>Quickly build and run simple single-file Flutter apps on the web.</p>
61+
</div>
62+
</a>
63+
<a class="card outlined-card" href="https://firebase.studio" target="_blank">
64+
<div class="card-header">
65+
<span class="card-title">
66+
<span>Firebase Studio</span>
67+
<span class="material-symbols" aria-hidden="true" style="font-size: 1rem;">open_in_new</span>
68+
</span>
69+
</div>
70+
<div class="card-content">
71+
<p>Develop complex Flutter apps in an AI-assisted workspace in the cloud.</p>
72+
</div>
73+
</a>
74+
</div>
75+
76+
## Other editors
77+
78+
You can develop Dart and Flutter apps using any other text editor and terminal.
79+
80+
Depending on the editor, you can integrate the Dart SDK's support for the
81+
[Language Server Protocol][lsp] and the [Debug Adapter Protocol][dap] to
82+
enable rich code editing and debugging features for both Dart and Flutter.
83+
84+
[lsp]: https://github.com/dart-lang/sdk/tree/main/pkg/analysis_server/tool/lsp_spec/README.md
85+
[dap]: https://github.com/dart-lang/sdk/blob/main/third_party/pkg/dap/tool/README.md

src/content/tools/hot-reload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,6 @@ widgets and render objects.
399399
[static-variables]: {{site.dart-site}}/language/classes#static-variables
400400
[const-new]: {{site.dart-site}}/language/variables#final-and-const
401401
[Dart Virtual Machine (VM)]: {{site.dart-site}}/overview#platform
402-
[Flutter editor]: /get-started/editor
402+
[Flutter editor]: /tools/editors
403403
[Issue 43574]: {{site.repo.flutter}}/issues/43574
404404
[kernel files]: {{site.github}}/dart-lang/sdk/tree/main/pkg/kernel

0 commit comments

Comments
 (0)