Skip to content

Commit

Permalink
chore: change base url to treefmt instead of treefmt-go
Browse files Browse the repository at this point in the history
In preparation for moving to the main treefmt repo.

Also fixes some broken links.

Signed-off-by: Brian McGee <brian@bmcgee.ie>
  • Loading branch information
brianmcgee committed May 12, 2024
1 parent 86d013f commit 4a86924
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -108,20 +108,20 @@ 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:

- [clang-format] for C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C#
- 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

Expand Down Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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 <a href="https://https://github.com/numtide/treefmt-go/src/branch/main/LICENSE.md">MIT License</a>.',
message: 'Released under the <a href="https://https://github.com/numtide/treefmt/src/branch/main/LICENSE.md">MIT License</a>.',
copyright: "Copyright © 2024-present Treefmt Contributors"
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ hero:
link: /quick-start
- theme: alt
text: More Info
link: /overview
link: /about
---
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 4a86924

Please sign in to comment.