diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ae8ccaf3..de0786f8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ top-level project. The underlying mechanisms for things like are implemented inside the `leiningen-core` subproject. See the -[readme for the leiningen-core library](https://codeberg.org/leiningen/leiningen/blob/main/leiningen-core/README.md) +[readme for the leiningen-core library](https://codeberg.org/leiningen/leiningen/src/main/leiningen-core/README.md) and `doc/PLUGINS.md` for more details on how Leiningen's codebase is structured. diff --git a/README.md b/README.md index 2182509bd..e0c94f76b 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ instead. ## Basic Usage The -[tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md) +[tutorial](https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md) has a detailed walk-through of the steps involved in creating a new project, but here are the commonly-used tasks: @@ -86,12 +86,12 @@ The `project.clj` file in the project root should look like this: The `lein new` task generates a project skeleton with an appropriate starting point from which you can work. See the -[sample.project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj) +[sample.project.clj](https://codeberg.org/leiningen/leiningen/src/stable/sample.project.clj) file (also available via `lein help sample`) for a detailed listing of configuration options. The `project.clj` file can be customized further with the use of -[profiles](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md). +[profiles](https://codeberg.org/leiningen/leiningen/src/stable/doc/PROFILES.md). ## Documentation @@ -99,19 +99,19 @@ Leiningen documentation is organized as a number of guides: ### Usage - * [Tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md) (start here if you are new) - * [FAQ](https://codeberg.org/leiningen/leiningen/blob/stable/doc/FAQ.md) - * [Profiles](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md) - * [Deployment & Distribution of Libraries](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md) - * [Sample project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj) - * [Polyglot (e.g. Clojure/Java) projects](https://codeberg.org/leiningen/leiningen/blob/stable/doc/MIXED_PROJECTS.md) + * [Tutorial](https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md) (start here if you are new) + * [FAQ](https://codeberg.org/leiningen/leiningen/src/stable/doc/FAQ.md) + * [Profiles](https://codeberg.org/leiningen/leiningen/src/stable/doc/PROFILES.md) + * [Deployment & Distribution of Libraries](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md) + * [Sample project.clj](https://codeberg.org/leiningen/leiningen/src/stable/sample.project.clj) + * [Polyglot (e.g. Clojure/Java) projects](https://codeberg.org/leiningen/leiningen/src/stable/doc/MIXED_PROJECTS.md) ### Development -* [Writing Plugins](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PLUGINS.md) -* [Writing Templates](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TEMPLATES.md) -* [Contributing](https://codeberg.org/leiningen/leiningen/blob/stable/CONTRIBUTING.md) -* [Building Leiningen](https://codeberg.org/leiningen/leiningen/blob/stable/CONTRIBUTING.md#bootstrapping) +* [Writing Plugins](https://codeberg.org/leiningen/leiningen/src/stable/doc/PLUGINS.md) +* [Writing Templates](https://codeberg.org/leiningen/leiningen/src/stable/doc/TEMPLATES.md) +* [Contributing](https://codeberg.org/leiningen/leiningen/src/stable/CONTRIBUTING.md) +* [Building Leiningen](https://codeberg.org/leiningen/leiningen/src/stable/CONTRIBUTING.md#bootstrapping) ## Plugins @@ -122,9 +122,9 @@ runs, (such as `lein-tar`) then it should be added to `:plugins` in project.clj, but if it's for your own convenience (such as `lein-pprint`) then it should be added to the `:plugins` list in the `:user` profile in `~/.lein/profiles.clj`. See the -[profiles guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md) +[profiles guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/PROFILES.md) for details on how to add to your `:user` profile. The -[plugin guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PLUGINS.md) +[plugin guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/PLUGINS.md) explains how to write plugins. ## License diff --git a/doc/DEPLOY.md b/doc/DEPLOY.md index 2e43f1c31..ec08fa5fd 100644 --- a/doc/DEPLOY.md +++ b/doc/DEPLOY.md @@ -25,7 +25,7 @@ Getting your library into [Clojars](https://clojars.org) is fairly straightforward as is documented near the end of -[the Leiningen tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md). +[the Leiningen tutorial](https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md). However, deploying elsewhere is not always that straightforward. ## Private Repositories @@ -137,7 +137,7 @@ haven't set up credentials, but it's convenient to set it so you don't have to re-enter it every time you want to deploy. You will need [gpg](https://www.gnupg.org/) installed and a key pair configured. If you need help with either of those, see the -[GPG guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/GPG.md). +[GPG guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/GPG.md). ### GPG diff --git a/doc/FAQ.md b/doc/FAQ.md index b2ccf42cd..fb9de6e03 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -13,7 +13,7 @@ **Q:** What's a group ID? How do snapshots work? **A:** See the - [tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md) + [tutorial](https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md) for background. **Q:** How should I pick my version numbers? @@ -25,7 +25,7 @@ **Q:** What if my project depends on jars that aren't in any repository? **A:** You will need to get them in a repository. The - [deploy guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md) + [deploy guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md) explains how to set up a private repository. In general it's easiest to deploy them to a static HTTP server or a private S3 bucket. Once the repo is set up, `lein deploy private-repo com.mycorp/somejar @@ -38,7 +38,7 @@ **Q:** I want to hack a project and one of its dependencies, but it's annoying to switch between them. **A:** Leiningen provides a feature called *checkout dependencies* to make this smoother. See the - [tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md) + [tutorial](https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md) to learn more. **Q:** Is it possible to exclude indirect dependencies? @@ -239,7 +239,7 @@ happens it is strongly recommended to add an `:exclusion` and report a bug with the dependency which does this. **Q:** `lein`/`lein.bat` won't download `leiningen-x.y.z-SNAPSHOT.jar` -**A:** You probably downloaded `lein`/`lein.bat` from the [main branch](https://codeberg.org/leiningen/leiningen/tree/main/bin). Unless you plan to build leiningen yourself or help develop it, we suggest you use the latest stable version: [lein](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein)/[lein.bat](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein.bat) +**A:** You probably downloaded `lein`/`lein.bat` from the [main branch](https://codeberg.org/leiningen/leiningen/src/main/bin). Unless you plan to build leiningen yourself or help develop it, we suggest you use the latest stable version: [lein](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein)/[lein.bat](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein.bat) **Q:** I have a dependency whose group ID and/or artifact ID starts with a number (which is invalid for symbols in Clojure). How can I add it to my diff --git a/doc/GPG.md b/doc/GPG.md index e8ae60a2f..edf96e39c 100644 --- a/doc/GPG.md +++ b/doc/GPG.md @@ -183,7 +183,7 @@ Leiningen uses GPG for three things: decrypting credential files, signing release artifacts, and signing tags. We'll focus on artifact signing here; for information on credentials encryption/decryption, see the -[deploy guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md). Once +[deploy guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md). Once you are configured to sign releases, signing tags should be straightforward. diff --git a/doc/PLUGINS.md b/doc/PLUGINS.md index d22afa472..3af80f4a9 100644 --- a/doc/PLUGINS.md +++ b/doc/PLUGINS.md @@ -87,11 +87,11 @@ has `:eval-in-leiningen true`, which causes all tasks to operate inside the leiningen process rather than starting a subprocess to isolate the project's code. Plugins need not declare a dependency on Clojure itself; in fact -[all of Leiningen's own dependencies](https://codeberg.org/leiningen/leiningen/blob/stable/project.clj) +[all of Leiningen's own dependencies](https://codeberg.org/leiningen/leiningen/src/stable/project.clj) will be available. See the `lein-pprint` directory -[in the Leiningen source](https://codeberg.org/leiningen/leiningen/tree/stable/lein-pprint) +[in the Leiningen source](https://codeberg.org/leiningen/leiningen/src/stable/lein-pprint) for a sample of a very simple plugin. When emitting output, please use `leiningen.core.main/info`, diff --git a/doc/PROFILES.md b/doc/PROFILES.md index 0315fd6f7..34338f1ab 100644 --- a/doc/PROFILES.md +++ b/doc/PROFILES.md @@ -252,7 +252,7 @@ Here is an example of such a case: ## Debugging To see how a given profile affects your project map, use the -[lein-pprint](https://codeberg.org/leiningen/leiningen/tree/stable/lein-pprint) +[lein-pprint](https://codeberg.org/leiningen/leiningen/src/stable/lein-pprint) plugin: $ lein with-profile 1.4 pprint diff --git a/doc/TEMPLATES.md b/doc/TEMPLATES.md index bcbea1376..16e8eab2c 100644 --- a/doc/TEMPLATES.md +++ b/doc/TEMPLATES.md @@ -67,7 +67,7 @@ you wish to be part of your template. For everything you add, make sure the `liquid_cool.clj` file receives corresponding entries in that `->files` call. For examples to follow, have a look inside [the \*.clj files for the built-in -templates](https://codeberg.org/leiningen/leiningen/tree/stable/resources/leiningen/new). +templates](https://codeberg.org/leiningen/leiningen/src/stable/resources/leiningen/new). ## Testing Your Template diff --git a/doc/TUTORIAL.md b/doc/TUTORIAL.md index 54d0f78b9..1357f3d70 100644 --- a/doc/TUTORIAL.md +++ b/doc/TUTORIAL.md @@ -102,7 +102,7 @@ Next let's take a look at how projects are created. ## Creating a Project We'll assume you've got Leiningen installed as per the -[README](https://codeberg.org/leiningen/leiningen/blob/stable/README.md). +[README](https://codeberg.org/leiningen/leiningen/src/stable/README.md). Generating a new project is easy: $ lein new app my-stuff @@ -271,7 +271,7 @@ wider JVM community. You can add third-party repositories by setting the `:repositories` key in project.clj. See the -[sample.project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj) +[sample.project.clj](https://codeberg.org/leiningen/leiningen/src/stable/sample.project.clj) for examples on how to do so. This sample uses additional repositories such as the Sonatype repository which gives access to the latest SNAPSHOT development version of a library (Clojure or Java). It also contains other relevant settings regarding repositories such as update frequency. @@ -703,7 +703,7 @@ Given these pitfalls, it's best to use an uberjar if possible. If your project is a library and you would like others to be able to use it as a dependency in their projects, you will need to get it into a public repository. While it's possible to [maintain your own private -repository](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md) +repository](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md) or get it into [Central](https://search.maven.org), the easiest way is to publish it at [Clojars](https://clojars.org). Once you have [created an account](https://clojars.org/register) there, publishing @@ -749,7 +749,7 @@ they don't have to be re-entered every time, see `lein help deploying`. When deploying a release that's not a snapshot, Leiningen will attempt to sign it using [GPG](https://gnupg.org) to prove your authorship of the release. See the -[deploy guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md) +[deploy guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md) for details of how to set that up. The deploy guide includes instructions for deploying to other repositories as well. diff --git a/doc/ja/PLUGINS_ja.md b/doc/ja/PLUGINS_ja.md index a458bb7f7..cdd42c596 100644 --- a/doc/ja/PLUGINS_ja.md +++ b/doc/ja/PLUGINS_ja.md @@ -36,9 +36,9 @@ Leiningenのタスクはleiningen.$TASK名前空間にある$TASKという名前 ## プラグインを書く `lein new plugin myplugin`でプロジェクトを作成するところからはじめ、`leiningen.myplugin`名前空間の`myplugin`関数を編集してください。`project.clj`内にある`:eval-in-leningen true`によって、タスクはサブプロセスではなく、leiningenプロセス内部で動作します。プラグインは、clojureそのものへの依存関係を宣言する必要はありません。 -[Leiningen本体の依存関係全て](https://codeberg.org/leiningen/leiningen/blob/stable/project.clj)がプラグインから利用可能です。 +[Leiningen本体の依存関係全て](https://codeberg.org/leiningen/leiningen/src/stable/project.clj)がプラグインから利用可能です。 -非常に単純なプラグインの例として、 [ソースコード内の](https://codeberg.org/leiningen/leiningen/tree/stable/lein-pprint) +非常に単純なプラグインの例として、 [ソースコード内の](https://codeberg.org/leiningen/leiningen/src/stable/lein-pprint) `lein-pprint`ディレクトリを参照してください。 プラグインの開発中、プロジェクト内で`lein install`を再実行し、それからテストプロジェクトに切り替えるのは非常に手間がかかります。一度プラグインをインストールすれば、テストプロジェクト内の`.lein-classpath`ファイルに、プラグインの`src`ディレクトリのパスを記述しておくことでこの手間を省くことができます。そのプラグインが別の開発中のライブラリに依存している場合は、`.lein-classpath`にUNIXでは`:`、Windowsでは`;`のクラスパスセパレータで区切ってライブラリのディレクトリを追加することができます。 diff --git a/doc/ja/TUTORIAL_ja.md b/doc/ja/TUTORIAL_ja.md index 50043ceaa..fe8c8b7bc 100644 --- a/doc/ja/TUTORIAL_ja.md +++ b/doc/ja/TUTORIAL_ja.md @@ -109,7 +109,7 @@ Leiningen は*プロジェクト*とともに動作します。 ## プロジェクトの作成 わたしたちは、あなたが -[README](https://codeberg.org/leiningen/leiningen/blob/stable/README.md) +[README](https://codeberg.org/leiningen/leiningen/src/stable/README.md) にしたがって Leiningen をインストールしたと仮定します。 この時新しいプロジェクトを生成することは簡単です: @@ -282,7 +282,7 @@ maven レポジトリで、 [Central](https://search.maven.org/) は サードパーティのレポジトリは `:repositories` キーを project.clj に指定することで追加出来ます。 どのようにすれば良いのか -[sample.project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj) +[sample.project.clj](https://codeberg.org/leiningen/leiningen/src/stable/sample.project.clj) を見てみましょう。このサンプルは追加のレポジトリとして Sonatype レポジトリを使っていますが、 これは(Clojure や Java の)ライブラリの、最新のスナップショット開発バージョンへのアクセスを提供します。 このサンプルには同様に、レポジトリに関連する更新頻度などの設定が含まれています。 @@ -716,7 +716,7 @@ Leiningen の自分自身の JVM は実行され続け、不必要なメモリ もしプロジェクトがライブラリで、他の人がプロジェクトの中で 依存関係としてそのライブラリを使えるようにしたいときは、 そのライブラリをパブリックレポジトリに置く必要が出てきます。 -自分自身の[プライベートレポジトリを運用する](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md) +自分自身の[プライベートレポジトリを運用する](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md) こともできますし、 [Central](https://search.maven.org)に置くことも出来ますが、 最も簡単なのは[Clojars](https://clojars.org)で公開する方法でしょう。 @@ -749,7 +749,7 @@ Leiningen の自分自身の JVM は実行され続け、不必要なメモリ スナップショット版ではなくリリース版をデプロイするときは、 Leiningen は [GPG](https://gnupg.org) を使って署名を行い、 リリースの著作権を証明します。どのように設定を行うかの詳細については、 -[デプロイガイド](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md)を参考にしてください。 +[デプロイガイド](https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md)を参考にしてください。 デプロイガイドでは他のレポジトリへのデプロイ方法の説明もしています。 ## おわり! diff --git a/leiningen-core/README.md b/leiningen-core/README.md index 43aa34a14..b79a7b368 100644 --- a/leiningen-core/README.md +++ b/leiningen-core/README.md @@ -29,7 +29,7 @@ it looks up the task which was invoked. Tasks are just functions named after the task they implement and defined in the `leiningen.the-task` namespace. They usually take a project map as their argument, but can also run outside the context of a project. See the -[plugin guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PLUGINS.md) +[plugin guide](https://codeberg.org/leiningen/leiningen/src/stable/doc/PLUGINS.md) for more details on how tasks are written. The `apply-task` function looks up the task function, checks to make sure it can be applied to the provided arguments, and then calls it. diff --git a/leiningen-core/src/leiningen/core/main.clj b/leiningen-core/src/leiningen/core/main.clj index 1b199377e..d36cd8731 100644 --- a/leiningen-core/src/leiningen/core/main.clj +++ b/leiningen-core/src/leiningen/core/main.clj @@ -434,7 +434,7 @@ Get the latest version of Leiningen at https://leiningen.org or by executing (abort "Tried to use insecure HTTP repository without TLS:\n" (str (.getId @repo) ": " (.getUrl @repo) "\n " resource) "\n" "\nThis is almost certainly a mistake; for details see" - "\nhttps://codeberg.org/leiningen/leiningen/blob/main/doc/FAQ.md"))))) + "\nhttps://codeberg.org/leiningen/leiningen/src/main/doc/FAQ.md"))))) (defn -main "Command-line entry point." diff --git a/web/index.html b/web/index.html index 5f26af360..4d570404b 100644 --- a/web/index.html +++ b/web/index.html @@ -97,7 +97,7 @@
The tutorial +
The tutorial is the best place to start. If you have Leiningen installed, you can read the tutorial by running lein help tutorial. It does not cover learning the @@ -107,17 +107,17 @@
Running lein help faq will get you the - FAQ. + FAQ. Documentation for each individual task is available via lein help $TASK. You can also - see the + see the sample project.clj file containing a reference of most project settings by running lein help sample.
More: - profiles | - deploying libraries | - writing plugins | + profiles | + deploying libraries | + writing plugins | plugin list
@@ -145,9 +145,9 @@