diff --git a/README.md b/README.md
index ef9ca4be..e8acc17e 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ To reformat the whole source tree, just type `treefmt` in any folder. This is a
## Installation
-You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt-go/releases).
+You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt/releases).
Otherwise, you can install the package from source code — either with [Go], or with the help of [nix].
We describe the installation process in detail in the [docs].
@@ -76,7 +76,7 @@ To explore the tool’s flags and options, type:
$ treefmt --help
```
-Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt-go-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix).
+Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix).
## Configuration
@@ -108,12 +108,12 @@ Before specifying the formatter in the config, make sure it’s installed.
To find and share existing formatter recipes, take a look at the [docs].
-If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt-go-nix) to use Nix to configure and bring in
+If you are a Nix user, you might also be interested in [treefmt-nix](https://github.com/numtide/treefmt-nix) to use Nix to configure and bring in
formatters.
## Compatibility
-`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt-go/blob/main/docs/formatters-spec.md).
+`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt/blob/main/docs/formatter-spec.md).
For instance, you can go for:
@@ -121,7 +121,7 @@ For instance, you can go for:
- gofmt for Golang
- Prettier for JavaScript/HTML/CSS
-Find the full list of supported formatters [here](https://numtide.github.io/treefmt-go/formatters).
+Find the full list of supported formatters [here](https://numtide.github.io/treefmt/configure.html#supported-formatters).
## Upcoming features
@@ -183,7 +183,7 @@ Unless explicitly stated otherwise, any contribution intentionally submitted for
[Rust]: https://www.rust-lang.org/
[Go]: https://go.dev/
[Toml]: https://toml.io/en/
-[docs]: https://numtide.github.io/treefmt-go/
+[docs]: https://numtide.github.io/treefmt/
[nix]: https://github.com/NixOS/nix
[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
[clang-format]: https://clang.llvm.org/docs/ClangFormat.html
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 25f92fd3..583bcfeb 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
- base: '/treefmt-go/',
+ base: '/treefmt/',
title: "Treefmt",
description: "one CLI to format your repo",
@@ -33,11 +33,11 @@ export default defineConfig({
],
socialLinks: [
- { icon: 'github', link: 'https://github.com/numtide/treefmt-go' }
+ { icon: 'github', link: 'https://github.com/numtide/treefmt' }
],
footer: {
- message: 'Released under the MIT License.',
+ message: 'Released under the MIT License.',
copyright: "Copyright © 2024-present Treefmt Contributors"
}
}
diff --git a/docs/contributing.md b/docs/contributing.md
index 642b067a..9254696a 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -12,14 +12,14 @@ The `treefmt` binaries and this user guide are licensed under the [MIT license](
## Before you contribute
-Here you can take a look at the [existing issues](https://github.com/numtide/treefmt-go/issues). Feel free to contribute, but make sure you have a
+Here you can take a look at the [existing issues](https://github.com/numtide/treefmt/issues). Feel free to contribute, but make sure you have a
[GitHub account](https://github.com/join) first :slightly_smiling_face:.
If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read,
and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.
Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please
-[state your question clearly in an issue](https://github.com/numtide/treefmt-go/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com).
+[state your question clearly in an issue](https://github.com/numtide/treefmt/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com).
## Creating an issue
diff --git a/docs/index.md b/docs/index.md
index 16543cb6..19978a18 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -14,5 +14,5 @@ hero:
link: /quick-start
- theme: alt
text: More Info
- link: /overview
+ link: /about
---
diff --git a/docs/install.md b/docs/install.md
index 7dcf9863..c906dd39 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -11,7 +11,7 @@ There are two ways to install `treefmt`:
## Download a binary file
-You can download the latest `treefmt` binaries [here](https://github.com/numtide/treefmt-go/releases).
+You can download the latest `treefmt` binaries [here](https://github.com/numtide/treefmt/releases).
## Build from source