Skip to content

Commit dc0cfd0

Browse files
RosemoeRosemoe
committed
update docs for new maven repo location
1 parent 67a5f0a commit dc0cfd0

2 files changed

Lines changed: 34 additions & 74 deletions

File tree

‎docs/guide/getting-started.md‎

Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ If you are not using Gradle as your build system, we won't provide information r
4646
:::
4747
## Add Dependencies
4848

49-
Newest Version: [![Maven Central](https://img.shields.io/maven-central/v/io.github.Rosemoe.sora-editor/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.Rosemoe.sora-editor%20editor))
49+
Newest Version: [![Maven Central](https://img.shields.io/maven-central/v/io.github.rosemoe/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.rosemoe%20editor))
5050

5151
Add sora-editor library to your app's dependencies:
5252

5353
::: code-group
5454

5555
```Kotlin{2-3} [Kotlin DSL]
5656
dependencies {
57-
implementation(platform("io.github.Rosemoe.sora-editor:bom:<versionName>"))
58-
implementation("io.github.Rosemoe.sora-editor:<moduleName>")
57+
implementation(platform("io.github.rosemoe:editor-bom:<versionName>"))
58+
implementation("io.github.rosemoe:<moduleName>")
5959
}
6060
```
6161

6262
```Groovy{2-3} [Groovy DSL]
6363
dependencies {
64-
implementation(platform("io.github.Rosemoe.sora-editor:bom:<versionName>"))
65-
implementation 'io.github.Rosemoe.sora-editor:<moduleName>'
64+
implementation(platform("io.github.rosemoe:editor-bom:<versionName>"))
65+
implementation 'io.github.rosemoe:<moduleName>'
6666
}
6767
```
6868

@@ -76,33 +76,33 @@ Here's an example for those who want to use TextMate grammars for syntax-highlig
7676

7777
```Kotlin{2-4} [Kotlin DSL]
7878
dependencies {
79-
implementation(platform("io.github.Rosemoe.sora-editor:bom:0.23.2"))
80-
implementation("io.github.Rosemoe.sora-editor:editor")
81-
implementation("io.github.Rosemoe.sora-editor:language-textmate")
79+
implementation(platform("io.github.rosemoe:editor-bom:0.23.7"))
80+
implementation("io.github.rosemoe:editor")
81+
implementation("io.github.rosemoe:language-textmate")
8282
}
8383
```
8484

8585
```Groovy{2-4} [Groovy DSL]
8686
dependencies {
87-
implementation(platform("io.github.Rosemoe.sora-editor:bom:0.23.2"))
88-
implementation 'io.github.Rosemoe.sora-editor:editor'
89-
implementation 'io.github.Rosemoe.sora-editor:language-textmate'
87+
implementation(platform("io.github.rosemoe:editor-bom:0.23.7"))
88+
implementation 'io.github.rosemoe:editor'
89+
implementation 'io.github.rosemoe:language-textmate'
9090
}
9191
```
9292

9393
```Kotlin{2-4} [Kotlin DSL without bom]
9494
dependencies {
95-
val editorVersion = "0.23.2"
96-
implementation("io.github.Rosemoe.sora-editor:editor:$editorVersion")
97-
implementation("io.github.Rosemoe.sora-editor:language-textmate:$editorVersion")
95+
val editorVersion = "0.23.7"
96+
implementation("io.github.rosemoe:editor:$editorVersion")
97+
implementation("io.github.rosemoe:language-textmate:$editorVersion")
9898
}
9999
```
100100

101101
```Groovy{2-4} [Groovy DSL without bom]
102102
dependencies {
103-
def editorVersion = '0.23.2'
104-
implementation 'io.github.Rosemoe.sora-editor:editor:$editorVersion'
105-
implementation 'io.github.Rosemoe.sora-editor:language-textmate:$editorVersion'
103+
def editorVersion = '0.23.7'
104+
implementation 'io.github.rosemoe:editor:$editorVersion'
105+
implementation 'io.github.rosemoe:language-textmate:$editorVersion'
106106
}
107107
```
108108

@@ -126,27 +126,6 @@ Check the table below to get more information about the modules.
126126
| language-java | A simple implementation for Java lexer-based highlighting and identifier auto-completion |
127127
| language-textmate | An advanced highlighter for the editor. It can be used to load TextMate language bundles and themes. The internal implementation of TextMate is from [tm4e](https://github.com/eclipse/tm4e) |
128128
| language-treesitter | Offer [tree-sitter](https://tree-sitter.github.io/tree-sitter/) support for editor. This can be used to parse the code to an AST fast and incrementally, which is helpful for accurate highlighting and providing completions. Note that this module only provides incremental parsing and highlighting. Thanks to Java bindings [android-tree-sitter](https://github.com/AndroidIDEOfficial/android-tree-sitter/) |
129-
### 🚧Snapshot Builds
130-
131-
Generally, it is recommended to use [released versions](https://github.com/Rosemoe/sora-editor/releases). But sometimes you may still want to use nightly builds for latest bug fixes and enhancements.
132-
133-
::: details How to Use Snapshot Builds
134-
135-
Snapshot versions are automatically published on repository push. You may combine current released version name
136-
and short commit hash to make a snapshot version name.
137-
138-
For example, if the latest released version name is '0.21.1' and
139-
short commit hash is '97c4963', you may use version name '0.21.1-97c4963-SNAPSHOT' to import the snapshot version to your project.
140-
141-
Note that adding extra maven repository is required:
142-
```Kotlin{3}
143-
repositories {
144-
// ...
145-
maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
146-
}
147-
```
148-
149-
:::
150129

151130
## Configure Desugaring for TextMate
152131

‎docs/zh/guide/getting-started.md‎

Lines changed: 17 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ android {
4646
:::
4747
## 添加依赖
4848

49-
最新版本: [![Maven Central](https://img.shields.io/maven-central/v/io.github.Rosemoe.sora-editor/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.Rosemoe.sora-editor%20editor))
49+
最新版本: [![Maven Central](https://img.shields.io/maven-central/v/io.github.rosemoe/editor.svg?label=Maven%20Central)]((https://search.maven.org/search?q=io.github.rosemoe%20editor))
5050

5151
添加sora-editor到您应用的依赖中:
5252

5353
::: code-group
5454

5555
```Kotlin{2-3} [Kotlin DSL]
5656
dependencies {
57-
implementation(platform("io.github.Rosemoe.sora-editor:bom:<版本名>"))
58-
implementation("io.github.Rosemoe.sora-editor:<模块名>")
57+
implementation(platform("io.github.rosemoe:editor-bom:<版本名>"))
58+
implementation("io.github.rosemoe:<模块名>")
5959
}
6060
```
6161

6262
```Groovy{2-3} [Groovy DSL]
6363
dependencies {
64-
implementation(platform("io.github.Rosemoe.sora-editor:bom:<版本名>"))
65-
implementation 'io.github.Rosemoe.sora-editor:<模块名>'
64+
implementation(platform("io.github.rosemoe:editor-bom:<版本名>"))
65+
implementation 'io.github.rosemoe:<模块名>'
6666
}
6767
```
6868

@@ -76,33 +76,33 @@ dependencies {
7676

7777
```Kotlin{2-4} [Kotlin DSL]
7878
dependencies {
79-
implementation(platform("io.github.Rosemoe.sora-editor:bom:0.23.2"))
80-
implementation("io.github.Rosemoe.sora-editor:editor")
81-
implementation("io.github.Rosemoe.sora-editor:language-textmate")
79+
implementation(platform("io.github.Rosemoe:editor-bom:0.23.7"))
80+
implementation("io.github.rosemoe:editor")
81+
implementation("io.github.rosemoe:language-textmate")
8282
}
8383
```
8484

8585
```Groovy{2-4} [Groovy DSL]
8686
dependencies {
87-
implementation(platform("io.github.Rosemoe.sora-editor:bom:0.23.2"))
88-
implementation 'io.github.Rosemoe.sora-editor:editor'
89-
implementation 'io.github.Rosemoe.sora-editor:language-textmate'
87+
implementation(platform("io.github.rosemoe:editor-bom:0.23.7"))
88+
implementation 'io.github.rosemoe:editor'
89+
implementation 'io.github.rosemoe:language-textmate'
9090
}
9191
```
9292

9393
```Kotlin{2-4} [Kotlin DSL(不使用bom)]
9494
dependencies {
95-
val editorVersion = "0.23.2"
96-
implementation("io.github.Rosemoe.sora-editor:editor:$editorVersion")
97-
implementation("io.github.Rosemoe.sora-editor:language-textmate:$editorVersion")
95+
val editorVersion = "0.23.7"
96+
implementation("io.github.rosemoe:editor:$editorVersion")
97+
implementation("io.github.rosemoe:language-textmate:$editorVersion")
9898
}
9999
```
100100

101101
```Groovy{2-4} [Groovy DSL(不使用bom)]
102102
dependencies {
103-
def editorVersion = '0.23.2'
104-
implementation 'io.github.Rosemoe.sora-editor:editor:$editorVersion'
105-
implementation 'io.github.Rosemoe.sora-editor:language-textmate:$editorVersion'
103+
def editorVersion = '0.23.7'
104+
implementation 'io.github.rosemoe:editor:$editorVersion'
105+
implementation 'io.github.rosemoe:language-textmate:$editorVersion'
106106
}
107107
```
108108

@@ -127,25 +127,6 @@ dependencies {
127127
| language-textmate | 一个高级的高亮分析库。你可以借助它来加载textmate语言配置文件并应用于本编辑器。 内部实现来自[tm4e](https://github.com/eclipse/tm4e)。 |
128128
| language-treesitter | 为编辑器提供[tree-sitter](https://tree-sitter.github.io/tree-sitter/)支持。tree-sitter可用于快速、增量地将代码转换 成抽象语法树，以便您向用户提供精确的高亮和自动补全功能。注意此模块仅提供了转换和高亮支持。感谢[android-tree-sitter](https://github.com/AndroidIDEOfficial/android-tree-sitter/)项目提供的Java绑定库。 |
129129

130-
### 🚧快照构建
131-
132-
通常情况下我们建议使用[正式发布的版本](https://github.com/Rosemoe/sora-editor/releases)。但有时候您可能需要使用最新的构建版本来修复最新出现的错误和新功能。
133-
134-
::: details 如何使用快照构建
135-
136-
快照版本在存储库推送时自动发布。您可以将当前发布的版本名称和短提交哈希值组合在一起，得到快照版本名称。
137-
138-
举个例子, 如果目前最新正式发布的版本是“0.21.1”，短提交哈希值为“97c4963”，则可以将'0.21.1-97c4963-SNAPSHOT'作为版本号导入快照版本到您的项目中。
139-
140-
需要注意的是，使用快照版本您需要额外添加一个maven存储库：
141-
```Kotlin{3}
142-
repositories {
143-
// ...
144-
maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
145-
}
146-
```
147-
148-
:::
149130

150131
## 为TextMate配置脱糖
151132

0 commit comments

Comments
 (0)