Db to markdown migration

Author: SimonSchubert

.gitignore

@@ -13,7 +13,8 @@ local.properties
 *.aab
 *.jar
 /html
-/assets/tldr
 .claude
-/data/intructions.md
-/data/processed.txt
+processed.txt
+instructions-tldr.md
+instructions-man.md
+commands.txt

README.md

@@ -2,7 +2,10 @@
 
 ![Icon](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandLibrary/master/art/web_hi_res_144.png)
 
-The app currently has **7896** manual pages, **22+** basic categories and a bunch of general terminal tips. It works 100% offline, doesn't need an internet connection and has no tracking software.
+BREAKING CHANGE:
+All commands, tips and basics are now defined as markdown files in /assets and the database.db has been removed from the project.
+
+The app currently has **4285** manual pages, **22+** basic categories and a bunch of general terminal tips. It works 100% offline, doesn't need an internet connection and has no tracking software.
 
 [![Play Store](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandBibliotheca/master/art/play_store_badge.png)](https://play.google.com/store/apps/details?id=com.inspiredandroid.linuxcommandbibliotheca)
 [![F-Droid](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandBibliotheca/master/art/fdroid_badge.png)](https://f-droid.org/en/packages/com.inspiredandroid.linuxcommandbibliotheca/)
@@ -29,7 +32,7 @@ Execute `gradle :cli:buildJar` to create jar file for Linux, Windows and Mac.
 
 #### Categories
 
-One-liners, System information, System control, Users & Groups, Files & Folders, Input, Printing, JSON, Network, Search & Find, GIT, SSH, Video & Audio, Package manager, Hacking tools, Terminal games, Crypto currencies, VIM Texteditor, Emacs Texteditor, Nano Texteditor, Pico Texteditor, Micro Texteditor
+Coding Agents, System information, System control, Users & Groups, Files & Folders, Input, Printing, JSON, Network, Search & Find, GIT, SSH, Video & Audio, Package manager, Hacking tools, Terminal games, Crypto currencies, VIM Texteditor, Emacs Texteditor, Nano Texteditor, Pico Texteditor, Micro Texteditor
 
 #### Tips
 
@@ -49,7 +52,7 @@ Common code unit tests: [CommonTests.kt](common/src/commonTest/kotlin/CommonTest
 
 ### Licensing
 
-The source code is licensed under the Apache 2.0 license and the copyright of the man pages in the `database.db` file are copyrighted by their respective authors.
+The source code is licensed under the Apache 2.0 license and the copyright of the man pages are copyrighted by their respective authors.
 
 ### Thanks to
 

android/src/main/java/com/inspiredandroid/linuxcommandbibliotheca/IconResources.kt

@@ -148,5 +148,6 @@ fun BasicCategory.getIconResource(): Int = when (title) {
     "Input" -> R.drawable.ic_icon_mouse
     "JSON" -> R.drawable.ic_icon_json
     "Fun" -> R.drawable.ic_icon_fun
+    "Coding Agents" -> R.drawable.ic_agent
     else -> R.drawable.ic_icon_mouse
 }

android/src/main/java/com/inspiredandroid/linuxcommandbibliotheca/data/BasicsRepository.kt

@@ -1,6 +1,7 @@
 package com.inspiredandroid.linuxcommandbibliotheca.data
 
 import android.content.Context
+import com.linuxcommandlibrary.shared.basicsSortOrder
 
 class BasicsRepository(private val context: Context) {
 
@@ -19,7 +20,7 @@ class BasicsRepository(private val context: Context) {
                     null
                 }
             }
-            .sortedBy { it.title }
+            .sortedBy { basicsSortOrder.indexOf(it.title) }
     }
 
     private fun readCategoryTitle(filename: String): String? = try {
@@ -51,7 +52,7 @@ class BasicsRepository(private val context: Context) {
                         commandsByGroupId[groupId] = mutableListOf()
                         commandIndex = 0
                     }
-                    line.contains("<code>") && currentGroupId != null -> {
+                    line.trim().startsWith("```") && line.trim().endsWith("```") && currentGroupId != null -> {
                         val (command, mans) = parseCommandLine(line)
                         val commandId = (categoryId + currentGroupId + commandIndex).hashCode().toLong()
                         commandsByGroupId[currentGroupId]?.add(
@@ -69,26 +70,18 @@ class BasicsRepository(private val context: Context) {
     }
 
     private fun parseCommandLine(line: String): Pair<String, String> {
-        // Extract command from <code>...</code>
-        val codeRegex = Regex("<code>(.*?)</code>")
-        val codeMatch = codeRegex.find(line)
-        val codeContent = codeMatch?.groupValues?.get(1) ?: ""
+        // Extract code content from ```...```
+        val codeContent = line.trim().removeSurrounding("```")
 
-        // Extract man links from <a href="/man/xxx">
-        val manRegex = Regex("""<a href="/man/([^"]+)">""")
+        // Extract man page names from [text](/man/xxx) links
+        val manRegex = Regex("""\[([^\]]+)]\(/man/([^)]+)\)""")
         val mans = manRegex.findAll(codeContent)
-            .map { it.groupValues[1] }
+            .map { it.groupValues[2] }
             .distinct()
             .joinToString(",")
 
-        // Remove HTML tags to get clean command text
-        val command = codeContent
-            .replace(Regex("""<a href="[^"]*">"""), "")
-            .replace("</a>", "")
-            .replace("&gt;", ">")
-            .replace("&lt;", "<")
-            .replace("&amp;", "&")
-            .trim()
+        // Remove markdown link syntax to get clean command text
+        val command = codeContent.replace(manRegex, "$1").trim()
 
         return Pair(command, mans)
     }

android/src/main/java/com/inspiredandroid/linuxcommandbibliotheca/data/CommandsRepository.kt

@@ -45,8 +45,6 @@ class CommandsRepository(private val context: Context) {
             )
     }
 
-    fun getCommand(name: String): CommandInfo? = getCommands().find { it.name == name }
-
     fun hasCommand(name: String): Boolean = getCommands().any { it.name == name }
 
     fun getSections(commandName: String): List<CommandSectionInfo> {

android/src/main/java/com/inspiredandroid/linuxcommandbibliotheca/ui/composables/TipSectionContent.kt

@@ -0,0 +1,96 @@
+package com.inspiredandroid.linuxcommandbibliotheca.ui.composables
+
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.text.AnnotatedString
+import androidx.compose.ui.text.SpanStyle
+import androidx.compose.ui.text.buildAnnotatedString
+import androidx.compose.ui.text.font.FontStyle
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.withStyle
+import androidx.compose.ui.unit.Dp
+import androidx.compose.ui.unit.dp
+import com.linuxcommandlibrary.shared.TextElement
+import com.linuxcommandlibrary.shared.TipSectionElement
+import kotlinx.collections.immutable.toImmutableList
+
+/* Copyright 2022 Simon Schubert
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+fun buildTextElementString(elements: List<TextElement>): AnnotatedString = buildAnnotatedString {
+    elements.forEach { textElement ->
+        when (textElement) {
+            is TextElement.Plain -> append(textElement.text)
+            is TextElement.Bold -> {
+                withStyle(style = SpanStyle(fontWeight = FontWeight.Bold)) {
+                    append(textElement.text)
+                }
+            }
+            is TextElement.Italic -> {
+                withStyle(style = SpanStyle(fontStyle = FontStyle.Italic)) {
+                    append(textElement.text)
+                }
+            }
+            is TextElement.Man -> append(textElement.man)
+        }
+    }
+}
+
+@Composable
+fun TipSectionContent(
+    sections: List<TipSectionElement>,
+    onNavigate: (String) -> Unit,
+    textColor: Color = Color.Unspecified,
+    commandVerticalPadding: Dp = 0.dp,
+) {
+    sections.forEach { section ->
+        when (section) {
+            is TipSectionElement.Text -> {
+                Text(
+                    text = buildTextElementString(section.elements),
+                    color = textColor,
+                )
+            }
+
+            is TipSectionElement.Blockquote -> {
+                Text(
+                    text = buildTextElementString(section.elements),
+                    color = textColor,
+                    modifier = Modifier.padding(start = 8.dp, bottom = 8.dp),
+                )
+            }
+
+            is TipSectionElement.Code -> {
+                CommandView(
+                    command = section.command,
+                    elements = section.elements.toImmutableList(),
+                    onNavigate = onNavigate,
+                    verticalPadding = commandVerticalPadding,
+                )
+            }
+
+            is TipSectionElement.Table -> {
+                TableView(
+                    headers = section.headers,
+                    rows = section.rows,
+                    onNavigate = onNavigate,
+                )
+            }
+        }
+    }
+}

android/src/main/java/com/inspiredandroid/linuxcommandbibliotheca/ui/screens/commanddetail/CommandDetailScreen.kt

@@ -12,7 +12,7 @@ import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.lazy.LazyColumn
-import androidx.compose.foundation.lazy.items
+import androidx.compose.foundation.lazy.itemsIndexed
 import androidx.compose.material.Chip
 import androidx.compose.material.ExperimentalMaterialApi
 import androidx.compose.material.ListItem
@@ -62,11 +62,11 @@ fun CommandDetailScreen(
     val uiState by viewModel.state.collectAsStateWithLifecycle()
 
     LazyColumn(Modifier.fillMaxSize()) {
-        items(
+        itemsIndexed(
             items = uiState.sections,
-            key = { it.id },
-            contentType = { "command_section_item" },
-        ) { section ->
+            key = { index, _ -> index },
+            contentType = { _, _ -> "command_section_item" },
+        ) { _, section ->
             CommandSectionColumn(
                 section = section,
                 isExpanded = uiState.expandedSectionsMap.getOrDefault(section.id, false),

android/src/main/res/drawable/ic_agent.xml

@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="960"
+    android:viewportHeight="960">
+  <path
+      android:pathData="M440,840v-80h320v-284q0,-117 -81.5,-198.5T480,196q-117,0 -198.5,81.5T200,476v244h-40q-33,0 -56.5,-23.5T80,640v-80q0,-21 10.5,-39.5T120,491l3,-53q8,-68 39.5,-126t79,-101q47.5,-43 109,-67T480,120q68,0 129,24t109,66.5Q766,253 797,311t40,126l3,52q19,9 29.5,27t10.5,38v92q0,20 -10.5,38T840,711v49q0,33 -23.5,56.5T760,840L440,840ZM360,560q-17,0 -28.5,-11.5T320,520q0,-17 11.5,-28.5T360,480q17,0 28.5,11.5T400,520q0,17 -11.5,28.5T360,560ZM600,560q-17,0 -28.5,-11.5T560,520q0,-17 11.5,-28.5T600,480q17,0 28.5,11.5T640,520q0,17 -11.5,28.5T600,560ZM241,498q-7,-106 64,-182t177,-76q89,0 156.5,56.5T720,441q-91,-1 -167.5,-49T435,262q-16,80 -67.5,142.5T241,498Z"
+      android:fillColor="#1f1f1f"/>
+</vector>

assets/basics/codingagents.md

@@ -0,0 +1,20 @@
+# Coding Agents
+
+## CLI
+```[claude](/man/claude)```
+```[opencode](/man/opencode)```
+```[copilot](/man/copilot)```
+```[grok](/man/grok)```
+```[gemini](/man/gemini)```
+```[codex](/man/codex)```
+```[interpreter](/man/interpreter)```
+```[aider](/man/aider)```
+```[forge](/man/forge)```
+```[vibe](/man/vibe)```
+```[crush](/man/crush)```
+```[plandex](/man/plandex)```
+```[qwen-code](/man/qwen-code)```
+```[q](/man/q)```
+```[droid](/man/droid)```
+```[kimi](/man/kimi)```
+```[bondai](/man/bondai)```

assets/basics/cryptocurrencies.md

@@ -0,0 +1,46 @@
+# Crypto currencies
+
+## Miners
+```[minergate](/man/minergate)```
+```[xmrig](/man/xmrig)```
+```[bfgminer](/man/bfgminer)```
+```[multiminer](/man/multiminer)```
+```[awesomeminer](/man/awesomeminer)```
+```[cgminer](/man/cgminer)```
+```[cardano-node](/man/cardano-node)```
+```[polkadot](/man/polkadot)```
+```[lotus-miner](/man/lotus-miner)```
+```[lnd](/man/lnd)```
+
+## Wallets
+```[electrum](/man/electrum)```
+```[daedalus](/man/daedalus)```
+```[armory](/man/armory)```
+```[exodus](/man/exodus)```
+```[eidoo](/man/eidoo)```
+```[mycrypto](/man/mycrypto)```
+```[jaxx](/man/jaxx)```
+```[wasabi](/man/wasabi)```
+```[mymonero](/man/mymonero)```
+```[multidoge](/man/multidoge)```
+```[dogecoincore](/man/dogecoincore)```
+```[guarda](/man/guarda)```
+```[geth](/man/geth)```
+
+## Trading Bots
+```[krypto-trading-bot](/man/krypto-trading-bot)```
+```[freqtrade](/man/freqtrade)```
+```[gekko](/man/gekko)```
+```[blackbird](/man/blackbird)```
+```[gocryptotrader](/man/gocryptotrader)```
+```[hummingbot](/man/hummingbot)```
+```[bitvision](/man/bitvision)```
+```[tradinggym](/man/tradinggym)```
+```[node-binance-trader](/man/node-binance-trader)```
+```[octobot](/man/octobot)```
+```[r2](/man/r2)```
+```[peregrine](/man/peregrine)```
+
+## Coin Tracker
+```[cointop](/man/cointop)```
+```[coinmon](/man/coinmon)```