doc(rome_cli): Use permalinks in `rome init`
MODIFY
crates/rome_cli/src/commands/init.rs
crates/rome_cli/src/commands/init.rs
use crate::{CliSession, Termination};
-use rome_console::{markup, ConsoleExt};
+use rome_console::{markup, ConsoleExt, HorizontalLine};
use rome_service::configuration::Configuration;
use rome_service::create_config;
pub(crate) fn init(mut session: CliSession) -> Result<(), Termination> {
let fs = &mut session.app.fs;
create_config(fs, Configuration::default())?;
- let message = markup! {
- <Info><Emphasis>"Files created:"</Emphasis></Info>"
-\t"<Emphasis>"- rome.json: "</Emphasis>"Your project configuration. Documentation: "<Underline>"https://rome.tools/docs/#configuration"</Underline>"
-
-"<Info><Emphasis>"Next Steps:"</Emphasis></Info>"
-\t1. "<Emphasis>"Setup your editor:"</Emphasis>"
-\t\tGet live errors as you type and format when you save. Learn more: "<Underline>"https://rome.tools/#editor-setup"</Underline>"
-\t2. "<Emphasis>"Try a command"</Emphasis>"
-\t\t"<Italic>"rome ci"</Italic>" is used to validate your code, verify formatting, and check for lint errors. Run " <Italic>"rome --help"</Italic>" for a full list of commands and flags
-\t3. "<Emphasis>"Read the documentation"</Emphasis>"
-\t\tOur website serves as a comprehensive source of guides and documentation: "<Underline>"https://rome.tools/docs"</Underline>"
-\t4. "<Emphasis>"Get involved in the community"</Emphasis>"
-\t\tAsk questions, get support, or contribute by participating on GitHub ("<Underline>"https://github.com/rome/tools"</Underline>"), or our community Discord ("<Underline>"https://discord.gg/rome"</Underline>")"
- };
-
- session.app.console.log(message);
+
+ session.app.console.log(markup! {
+"\n"<Inverse>"Welcome to Rome! Let's get you started..."</Inverse>"
+
+"<Info><Emphasis>"Files created "</Emphasis></Info>{HorizontalLine::new(106)}"
+
+ "<Dim>"- "</Dim><Emphasis>"rome.json: "</Emphasis>"Your project configuration. Documentation: "<Hyperlink href="https://rome.tools/configuration">"https://rome.tools/configuration"</Hyperlink>"
+
+"<Info><Emphasis>"Next Steps "</Emphasis></Info>{HorizontalLine::new(109)}"
+
+ "<Dim>"1."</Dim>" "<Emphasis>"Setup an editor extension"</Emphasis>"
+ Get live errors as you type and format when you save. Learn more: "<Hyperlink href="https://rome.tools/editors">"https://rome.tools/editors"</Hyperlink>"
+
+ "<Dim>"2."</Dim>" "<Emphasis>"Try a command"</Emphasis>"
+ "<Italic>"rome ci"</Italic>" checks for lint errors and verifies formatting. Run " <Italic>"rome --help"</Italic>" for a full list of commands and options.
+
+ "<Dim>"3."</Dim>" "<Emphasis>"Read the documentation"</Emphasis>"
+ Our website serves as a comprehensive source of guides and documentation: "<Hyperlink href="https://rome.tools/docs">"https://rome.tools/docs"</Hyperlink>"
+
+ "<Dim>"4."</Dim>" "<Emphasis>"Get involved in the community"</Emphasis>"
+ Ask questions, get support, or contribute by participating on GitHub ("<Hyperlink href="https://github.com/rome/tools">"https://github.com/rome/tools"</Hyperlink>"),
+ or join our community Discord ("<Hyperlink href="https://discord.gg/rome">"https://discord.gg/rome"</Hyperlink>")"
+ });
Ok(())
}

MODIFY
website/src/_includes/docs/configuration.md
website/src/_includes/docs/configuration.md
+<!-- Make sure to update the redirect in `static/_redirects` when changing the configuration title -->
## Configuration
The configuration file is considered **optional**, Rome has good defaults. Use the configuration

MODIFY
website/src/_includes/docs/formatter.md
website/src/_includes/docs/formatter.md
@@ -9,7 +9,7 @@ The language agnostic options supported by Rome are:
- indent style (default: `tabs`): Use spaces or tabs for indention
- tab width (default: `2`): The number of spaces per indention level
-- line width (default: `80)`: The column width at which Rome wraps code
+- line width (default: `80`): The column width at which Rome wraps code
### Use the formatter with the CLI

MODIFY
website/src/_includes/docs/getting-started.md
website/src/_includes/docs/getting-started.md
@@ -109,7 +109,7 @@ yarn run rome format <files> --write
```
-
+<!-- Make sure to update the redirect in `static/_redirects` when changing the editors title -->
### Editor Setup
We recommend installing our editor integration to get the most out of Rome. The Rome editor integration allows you to:

ADD
website/static/_redirects
+# URLs used in the CLI `init` command.
+/editors /docs/#editor-setup
+/configuration /docs/#configuration-1

doc(rome_cli): Use permalinks in `rome init` (#3550)