Skip to content

Commit e85a96f

Browse files
authored
docs: updated links to open in new tab and corrected docs github url
1 parent ae2a2c8 commit e85a96f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/tooling.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22

33
## Abstractions
44

5-
- [Taskfile](https://taskfile.dev/) - A simple and easy to use task runner / build tool that aims to be a simpler and more powerful Make alternative. It is written in Go and uses a YAML file to define tasks. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
6-
- [Makefile](https://www.gnu.org/software/make/) - A build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
7-
- [Justfile](https://just.systems/) - A command runner that allows you to define and run commands in a simple and easy to use way. It is written in Rust and uses a simple syntax to define commands. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
5+
- [Taskfile](https://taskfile.dev/){target="_blank"} - A simple and easy to use task runner / build tool that aims to be a simpler and more powerful Make alternative. It is written in Go and uses a YAML file to define tasks. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
6+
- [Makefile](https://www.gnu.org/software/make/){target="_blank"} - A build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
7+
- [Justfile](https://just.systems/){target="_blank"} - A command runner that allows you to define and run commands in a simple and easy to use way. It is written in Rust and uses a simple syntax to define commands. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be run from the command line.
88

99
## IDE Agnostic Files
1010

11-
- [`.editorconfig`](https://editorconfig.org/) - A file format and collection of text editor plugins for maintaining consistent coding styles between different editors and IDEs. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports the EditorConfig file format.
12-
- [`.env`](https://12factor.net/config) - A plain text file that contains environment variables for a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports environment variables.
11+
- [`.editorconfig`](https://editorconfig.org/){target="_blank"} - A file format and collection of text editor plugins for maintaining consistent coding styles between different editors and IDEs. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports the EditorConfig file format.
12+
- [`.env`](https://12factor.net/config){target="_blank"} - A plain text file that contains environment variables for a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports environment variables.
1313

1414
### Git
1515

16-
- [`.gitignore`](https://git-scm.com/docs/gitignore) - A plain text file that tells Git which files and directories to ignore in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
17-
- [`.gitattributes`](https://git-scm.com/docs/gitattributes) - A plain text file that tells Git how to handle certain files in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
18-
- [`.gitmessage`](https://git-scm.com/docs/git-commit#_specifying_the_commit_message) - A plain text file that contains a template for commit messages. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
16+
- [`.gitignore`](https://git-scm.com/docs/gitignore){target="_blank"} - A plain text file that tells Git which files and directories to ignore in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
17+
- [`.gitattributes`](https://git-scm.com/docs/gitattributes){target="_blank"} - A plain text file that tells Git how to handle certain files in a project. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
18+
- [`.gitmessage`](https://git-scm.com/docs/git-commit#_specifying_the_commit_message){target="_blank"} - A plain text file that contains a template for commit messages. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Git.
1919

2020
## Pre-Commits
2121

22-
- [`.pre-commit-config.yaml`](https://pre-commit.com/) - A configuration file for the pre-commit framework, which is a tool for managing and maintaining multi-language pre-commit hooks. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports YAML files.
22+
- [`.pre-commit-config.yaml`](https://pre-commit.com/){target="_blank"} - A configuration file for the pre-commit framework, which is a tool for managing and maintaining multi-language pre-commit hooks. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports YAML files.
2323

2424
### Docker
2525

26-
- [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#dockerignore-file) - A plain text file that tells Docker which files and directories to ignore when building an image. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Docker.
26+
- [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#dockerignore-file){target="_blank"} - A plain text file that tells Docker which files and directories to ignore when building an image. It is cross platform and works on Windows, MacOS and Linux. It is also IDE agnostic as it can be used with any text editor or IDE that supports Docker.
2727

2828

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
site_name: Codebase Interface
22
site_description: A documented set of principles that aim to promote the ease of use of codebases across languages and frameworks
33
site_url: https://codebaseinterface.org
4-
repo_url: https://github.com/codebaseinterface/codebaseinterface
5-
repo_name: codebaseinterface/codebaseinterface
4+
repo_url: https://github.com/codebase-interface/codebaseinterface
5+
repo_name: codebase-interface/codebaseinterface
66
edit_uri: edit/main/docs/
77

88
theme:

0 commit comments

Comments
 (0)