Skip to content

Commit 4a86924

Browse files
committed
chore: change base url to treefmt instead of treefmt-go
In preparation for moving to the main treefmt repo. Also fixes some broken links. Signed-off-by: Brian McGee <[email protected]>
1 parent 86d013f commit 4a86924

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To reformat the whole source tree, just type `treefmt` in any folder. This is a
4848

4949
## Installation
5050

51-
You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt-go/releases).
51+
You can install `treefmt` by downloading the binary. Find the binaries for different architectures [here](https://github.com/numtide/treefmt/releases).
5252
Otherwise, you can install the package from source code — either with [Go], or with the help of [nix].
5353

5454
We describe the installation process in detail in the [docs].
@@ -76,7 +76,7 @@ To explore the tool’s flags and options, type:
7676
$ treefmt --help
7777
```
7878

79-
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).
79+
Additionally, there's a wrapper called [`treefmt-nix`](https://github.com/numtide/treefmt-nix) for using `treefmt` with [`nix`](https://github.com/NixOS/nix).
8080

8181
## Configuration
8282

@@ -108,20 +108,20 @@ Before specifying the formatter in the config, make sure it’s installed.
108108

109109
To find and share existing formatter recipes, take a look at the [docs].
110110

111-
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
111+
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
112112
formatters.
113113

114114
## Compatibility
115115

116-
`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt-go/blob/main/docs/formatters-spec.md).
116+
`treefmt` works with any formatter that adheres to the [following specification](https://github.com/numtide/treefmt/blob/main/docs/formatter-spec.md).
117117

118118
For instance, you can go for:
119119

120120
- [clang-format] for C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C#
121121
- gofmt for Golang
122122
- Prettier for JavaScript/HTML/CSS
123123

124-
Find the full list of supported formatters [here](https://numtide.github.io/treefmt-go/formatters).
124+
Find the full list of supported formatters [here](https://numtide.github.io/treefmt/configure.html#supported-formatters).
125125

126126
## Upcoming features
127127

@@ -183,7 +183,7 @@ Unless explicitly stated otherwise, any contribution intentionally submitted for
183183
[Rust]: https://www.rust-lang.org/
184184
[Go]: https://go.dev/
185185
[Toml]: https://toml.io/en/
186-
[docs]: https://numtide.github.io/treefmt-go/
186+
[docs]: https://numtide.github.io/treefmt/
187187
[nix]: https://github.com/NixOS/nix
188188
[nixpkgs-fmt]: https://github.com/nix-community/nixpkgs-fmt
189189
[clang-format]: https://clang.llvm.org/docs/ClangFormat.html

Diff for: docs/.vitepress/config.mts

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'
22

33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
5-
base: '/treefmt-go/',
5+
base: '/treefmt/',
66

77
title: "Treefmt",
88
description: "one CLI to format your repo",
@@ -33,11 +33,11 @@ export default defineConfig({
3333
],
3434

3535
socialLinks: [
36-
{ icon: 'github', link: 'https://github.com/numtide/treefmt-go' }
36+
{ icon: 'github', link: 'https://github.com/numtide/treefmt' }
3737
],
3838

3939
footer: {
40-
message: 'Released under the <a href="https://https://github.com/numtide/treefmt-go/src/branch/main/LICENSE.md">MIT License</a>.',
40+
message: 'Released under the <a href="https://https://github.com/numtide/treefmt/src/branch/main/LICENSE.md">MIT License</a>.',
4141
copyright: "Copyright © 2024-present Treefmt Contributors"
4242
}
4343
}

Diff for: docs/contributing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The `treefmt` binaries and this user guide are licensed under the [MIT license](
1212

1313
## Before you contribute
1414

15-
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
15+
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
1616
[GitHub account](https://github.com/join) first :slightly_smiling_face:.
1717

1818
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,
1919
and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.
2020

2121
Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please
22-
[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).
22+
[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).
2323

2424
## Creating an issue
2525

Diff for: docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ hero:
1414
link: /quick-start
1515
- theme: alt
1616
text: More Info
17-
link: /overview
17+
link: /about
1818
---

Diff for: docs/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are two ways to install `treefmt`:
1111

1212
## Download a binary file
1313

14-
You can download the latest `treefmt` binaries [here](https://github.com/numtide/treefmt-go/releases).
14+
You can download the latest `treefmt` binaries [here](https://github.com/numtide/treefmt/releases).
1515

1616
## Build from source
1717

0 commit comments

Comments
 (0)