Skip to content

Commit

Permalink
-Updated README to resolve image formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamParvinkarimi committed Oct 16, 2024
1 parent 1e4223a commit 92f3bda
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
13 changes: 0 additions & 13 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,6 @@ tasks {
sinceBuild = properties("pluginSinceBuild")
untilBuild = properties("pluginUntilBuild")

// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
pluginDescription = providers.fileContents(layout.projectDirectory.file("README.md")).asText.map {
val start = "<!-- Plugin description -->"
val end = "<!-- Plugin description end -->"

with (it.lines()) {
if (!containsAll(listOf(start, end))) {
throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
}
subList(indexOf(start) + 1, indexOf(end)).joinToString("\n").let(::markdownToHTML)
}
}

val changelog = project.changelog // local variable for configuration cache compatibility
// Get the latest available change notes from the changelog file
changeNotes = properties("pluginVersion").map { pluginVersion ->
Expand Down
14 changes: 14 additions & 0 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@
<name>Repo Depot</name>
<vendor>Repo Depot Team</vendor>

<description><![CDATA[
<p> <b>Repo Depot</b> is a simple JetBrains plugin that lets teams share common bookmarks through source control and open them through their IDE.</p>
<ul>
<li>Bookmarks are available under Tools</li>
<li>Bookmarks are maintained in the Settings UI</li>
<li>Bookmarks can be nested and organized within the Settings menu</li>
<li>The menu configuration persists in a root-level file called <code>repo_depot.json</code>. If the file doesn't exist, it'll be created automatically</li>
</ul>
<p><b>Note:</b></p>
<p>Teams may want to exclude <code>repot_depot.json</code> from their CI/CD processes to quickly change their bookmarks via pull requests, without triggering long-running build validation processes.</p>
]]></description>

<!-- This should mark the plugin as being compatible with IntelliJ IDEA & Android Studio per https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html-->
<depends>com.intellij.modules.java</depends>

Expand Down

0 comments on commit 92f3bda

Please sign in to comment.