mirror of
https://github.com/HighCapable/YukiReflection.git
synced 2025-09-10 12:34:06 +08:00
Deploy to GitHub pages
This commit is contained in:
github-actions[bot]
GitHub
53
assets/quick-start.html-uujte6L-.js
Normal file
53
assets/quick-start.html-uujte6L-.js
Normal file
@@ -0,0 +1,53 @@
|
||||
import{_ as o,r as i,o as t,c as p,b as s,d as n,e as a,a as l}from"./app-Un_zyw_U.js";const r={},c=l('<h1 id="quick-start" tabindex="-1"><a class="header-anchor" href="#quick-start" aria-hidden="true">#</a> Quick Start</h1><blockquote><p>Integrate <code>YukiReflection</code> into your project.</p></blockquote><h2 id="environment-requirements" tabindex="-1"><a class="header-anchor" href="#environment-requirements" aria-hidden="true">#</a> Environment Requirements</h2><ul><li><p>Windows 7 and above / macOS 10.14 and above / Linux distributions (Arch/Debian)</p></li><li><p>Android Studio 2021.1 and above</p></li><li><p>IntelliJ IDEA 2021.1 and above</p></li><li><p>Kotlin 1.7.0 and above</p></li><li><p>Android Gradle Plugin 7.0 and above</p></li><li><p>Gradle 7.0 and above</p></li><li><p>Java 11 and above</p></li><li><p>Java 17 and above (Since API <code>1.0.3</code>)</p></li></ul><h2 id="project-requirements" tabindex="-1"><a class="header-anchor" href="#project-requirements" aria-hidden="true">#</a> Project Requirements</h2><p>The project needs to be created using <code>Android Studio</code> or <code>IntelliJ IDEA</code> and the type is an Java or Android project and the Kotlin environment dependency has been integrated.</p><h2 id="integration-dependencies" tabindex="-1"><a class="header-anchor" href="#integration-dependencies" aria-hidden="true">#</a> Integration Dependencies</h2>',7),d={href:"https://github.com/HighCapable/SweetDependency",target:"_blank",rel:"noopener noreferrer"},u=l(`<h4 id="sweetdependency-recommended" tabindex="-1"><a class="header-anchor" href="#sweetdependency-recommended" aria-hidden="true">#</a> SweetDependency (Recommended)</h4><p>Add the repositories and dependencies in your project's <code>SweetDependency</code> configuration file.</p><blockquote><p>The following example</p></blockquote><div class="language-yaml line-numbers-mode" data-ext="yml"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#8DDB8C;">repositories</span><span style="color:#ADBAC7;">:</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;"># MavenCentral has a 2-hour cache,</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;"># if the latest version cannot be integrated, please add this</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#8DDB8C;">sonatype-oss-releases</span><span style="color:#ADBAC7;">:</span></span>
|
||||
<span class="line"></span>
|
||||
<span class="line"><span style="color:#8DDB8C;">libraries</span><span style="color:#ADBAC7;">:</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#8DDB8C;">com.highcapable.yukireflection</span><span style="color:#ADBAC7;">:</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#8DDB8C;">api</span><span style="color:#ADBAC7;">:</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#8DDB8C;">version</span><span style="color:#ADBAC7;">: </span><span style="color:#96D0FF;">+</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#6CB6FF;">...</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>After adding it, run Gradle Sync and all dependencies will be autowired.</p><p>Next, deploy dependencies in your project <code>build.gradle.kts</code>.</p><blockquote><p>The following example</p></blockquote><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">dependencies</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">implementation</span><span style="color:#ADBAC7;">(com.highcapable.yukireflection.api)</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;">// ...</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="traditional-method" tabindex="-1"><a class="header-anchor" href="#traditional-method" aria-hidden="true">#</a> Traditional Method</h4><p>Add repositories in your project <code>build.gradle.kts</code> or <code>build.gradle</code>.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">repositories</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">google</span><span style="color:#ADBAC7;">()</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">mavenCentral</span><span style="color:#ADBAC7;">()</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;">// MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">maven</span><span style="color:#ADBAC7;"> { </span><span style="color:#DCBDFB;">url</span><span style="color:#ADBAC7;">(</span><span style="color:#96D0FF;">"https://s01.oss.sonatype.org/content/repositories/releases/"</span><span style="color:#ADBAC7;">) }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy line-numbers-mode" data-ext="groovy"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#ADBAC7;">repositories {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> google()</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> mavenCentral()</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;">// MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> maven { url </span><span style="color:#96D0FF;">'https://s01.oss.sonatype.org/content/repositories/releases/'</span><span style="color:#ADBAC7;"> }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Add dependencies in your project <code>build.gradle.kts</code> or <code>build.gradle</code>.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">dependencies</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">implementation</span><span style="color:#ADBAC7;">(</span><span style="color:#96D0FF;">"com.highcapable.yukireflection:api:<yuki-version>"</span><span style="color:#ADBAC7;">)</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;">// ...</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy line-numbers-mode" data-ext="groovy"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#ADBAC7;">dependencies {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> implementation </span><span style="color:#96D0FF;">'com.highcapable.yukireflection:api:<yuki-version>'</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#768390;">// ...</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Please change <strong><yuki-version></strong> to the latest version <a href="../about/changelog">here</a>.</p>`,20),v={class:"custom-container danger"},y=s("p",{class:"custom-container-title"},"Pay Attention",-1),b={href:"https://github.com/HighCapable/YukiHookAPI",target:"_blank",rel:"noopener noreferrer"},A=s("strong",null,"YukiReflection",-1),m=s("strong",null,"YukiHookAPI",-1),h=s("p",null,"Repeated integration will cause functional conflicts and cause exceptions.",-1),D={href:"https://highcapable.github.io/YukiHookAPI/zh-cn/",target:"_blank",rel:"noopener noreferrer"},g=s("strong",null,"YukiHookAPI",-1),B=s("p",null,[s("strong",null,"YukiHookAPI"),n(" will be completely separated from "),s("strong",null,"YukiReflection"),n(" in version "),s("strong",null,"2.0.0"),n(", by which time you can use it with "),s("strong",null,"YukiHookAPI"),n(" at the same time.")],-1),C=l(`<h4 id="configure-java-version" tabindex="-1"><a class="header-anchor" href="#configure-java-version" aria-hidden="true">#</a> Configure Java Version</h4><p>Modify the Java version of Kotlin in your project <code>build.gradle.kts</code> or <code>build.gradle</code> to 17 or above.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">android</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">compileOptions</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> sourceCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> JavaVersion.VERSION_17</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> targetCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> JavaVersion.VERSION_17</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> </span><span style="color:#DCBDFB;">kotlinOptions</span><span style="color:#ADBAC7;"> {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> jvmTarget </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#96D0FF;">"17"</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy line-numbers-mode" data-ext="groovy"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#ADBAC7;">android {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> compileOptions {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> sourceCompatibility </span><span style="color:#F47067;">JavaVersion.</span><span style="color:#6CB6FF;">VERSION_17</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> targetCompatibility </span><span style="color:#F47067;">JavaVersion.</span><span style="color:#6CB6FF;">VERSION_17</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> kotlinOptions {</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> jvmTarget </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#96D0FF;">'17'</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;"> }</span></span>
|
||||
<span class="line"><span style="color:#ADBAC7;">}</span></span>
|
||||
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="custom-container warning"><p class="custom-container-title">Notice</p><p>Since API <strong>1.0.3</strong>, the Java version used by Kotlin defaults to 17, and versions 11 and below are no longer supported.</p></div>`,7);function k(f,_){const e=i("ExternalLinkIcon");return t(),p("div",null,[c,s("p",null,[n("We recommend using Kotlin DSL as the Gradle build script language and "),s("a",d,[n("SweetDependency"),a(e)]),n(" to manage dependencies.")]),u,s("div",v,[y,s("p",null,[n("If your project is currently using the 1.x.x version of "),s("a",b,[n("YukiHookAPI"),a(e)]),n(", please do not integrate "),A,n(" repeatedly, because "),m,n(" already includes it functions and there are changes to related functions.")]),h,s("p",null,[n("In this case, you should go to the "),s("a",D,[n("Documentation"),a(e)]),n(" of "),g,n(" view the corresponding usage tutorial.")]),B]),C])}const x=o(r,[["render",k],["__file","quick-start.html.vue"]]);export{x as default};
|
||||
Reference in New Issue
Block a user