+
+
+
+
+
+
+
+
+
+
+
+### CLI screenshot
+
+
+
+Execute `gradle :cli:buildJar` to create jar file for Linux, Windows and Mac.
+
+### Content
+
+#### 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
+
+#### Tips
+
+Clear and reset the terminal, List of recent commands, Close a frozen window/application, Tab Completion, Temporary aliases, Permanent aliases, Chain commands, Command syntax, Cursor navigation, Redirection, Special characters in commands, View file permissions, Modify file permissions, Set file permissions via binary references
+
+### CI/CD
+
+[Github Action](.github/workflows/android.yml) to automatically create a new Github release with APK and JAR and upload an AAB to the Play Store.
+
+### Tests
+
+Android Jetpack Compose screen tests: [ComposeTests.kt](android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeTests.kt)
+
+Android Jetpack Compose deeplinking tests: [ComposeDeeplinkTests.kt](android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeDeeplinkTests.kt)
+
+Common code unit tests: [CommonTests.kt](common/src/commonTest/kotlin/CommonTests.kt)
+
+### 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.
+
+### Thanks to
+
+http://letsgokoyo.com - App Icon
+
+https://www.commandlinefu.com - Lots of one-liners
+
+https://icons8.com - Icons
+
+https://tldr.sh - TLDR
diff --git a/android/build.gradle.kts b/android/build.gradle.kts
new file mode 100644
index 0000000..74991c0
--- /dev/null
+++ b/android/build.gradle.kts
@@ -0,0 +1,78 @@
+plugins {
+ alias(libs.plugins.android.application)
+ alias(libs.plugins.kotlin.android)
+ alias(libs.plugins.compose.compiler)
+}
+
+group = "com.inspiredandroid.linuxcommandbibliotheca"
+
+dependencies {
+ implementation(project(":common"))
+ implementation(libs.androidx.activity.compose)
+ implementation(libs.androidx.material)
+ implementation(libs.androidx.navigation.compose)
+ implementation(libs.accompanist.appcompat.theme)
+ implementation(libs.accompanist.systemuicontroller)
+ implementation(libs.androidx.lifecycle.viewmodel.compose)
+ implementation(libs.androidx.preference)
+ implementation(libs.androidx.ui.tooling.preview)
+ implementation(libs.androidx.material.icons.core)
+
+ implementation(libs.koin.core)
+ implementation(libs.koin.android)
+ implementation(libs.koin.androidx.compose)
+ implementation(libs.androidx.foundation)
+ implementation(libs.kotlinx.collections.immutable)
+
+ androidTestImplementation(libs.androidx.ui.test.junit4)
+ debugImplementation(libs.androidx.ui.test.manifest)
+ debugImplementation(libs.androidx.ui.tooling)
+}
+
+android {
+ compileSdk = 36
+ defaultConfig {
+ applicationId = "com.inspiredandroid.linuxcommandbibliotheca"
+ minSdk = 24
+ targetSdk = 36
+ versionCode =
+ libs.versions.androidVersionCode
+ .get()
+ .toInt()
+ versionName = libs.versions.appVersion.get()
+ testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+ }
+
+ buildTypes {
+ getByName("release") {
+ isMinifyEnabled = true
+ proguardFiles(
+ getDefaultProguardFile("proguard-android-optimize.txt"),
+ "proguard-rules.pro",
+ )
+ }
+ getByName("debug") {
+ isMinifyEnabled = false
+ }
+ }
+
+ sourceSets["main"].assets.setSrcDirs(listOf("../assets"))
+
+ buildFeatures {
+ compose = true
+ buildConfig = true
+ }
+
+ compileOptions {
+ sourceCompatibility = JavaVersion.VERSION_17
+ targetCompatibility = JavaVersion.VERSION_17
+ }
+ kotlinOptions {
+ jvmTarget = "17"
+ }
+
+ lint {
+ abortOnError = false
+ }
+ namespace = "com.inspiredandroid.linuxcommandbibliotheca"
+}
diff --git a/android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeDeeplinkTests.kt b/android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeDeeplinkTests.kt
new file mode 100644
index 0000000..a73e52c
--- /dev/null
+++ b/android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeDeeplinkTests.kt
@@ -0,0 +1,88 @@
+package com.inspiredandroid.linuxcommandbibliotheca
+
+import android.content.Context
+import android.content.Intent
+import android.net.Uri
+import androidx.compose.ui.test.assertTextEquals
+import androidx.compose.ui.test.junit4.createEmptyComposeRule
+import androidx.compose.ui.test.onNodeWithContentDescription
+import androidx.compose.ui.test.performClick
+import androidx.preference.PreferenceManager
+import androidx.test.core.app.ActivityScenario
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.linuxcommandlibrary.shared.initDatabase
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * Test if deeplinks from/to website open correct screens. If test started the first time
+ * "Always open urls with app" dialog has to be accepted. Or the app has to be signed with the
+ * release key for autoVerify to take effect.
+ */
+@RunWith(AndroidJUnit4::class)
+class ComposeDeeplinkTests {
+
+ private lateinit var scenario: ActivityScenario")
+ val mobileScreenshotFiles =
+ listOf("screen-1.png", "screen-2-dark.png", "screen-3.png", "screen-4-dark.png")
+ mobileScreenshotFiles.forEach { fileName ->
+ stream.appendLine("")
+ }
+ stream.appendLine("
![](\"https://raw.githubusercontent.com/SimonSchubert/LinuxCommandBibliotheca/master/art/screen-cli-1.png\")
")
+ stream.appendLine()
+ stream.appendLine("Execute `gradle :cli:buildJar` to create jar file for Linux, Windows and Mac.")
+ stream.appendLine()
+ stream.appendLine("### Content")
+ stream.appendLine()
+ stream.appendLine("#### Categories")
+ stream.appendLine()
+ stream.appendLine(
+ databaseHelper.getBasics().joinToString { category ->
+ category.title
+ },
+ )
+ stream.appendLine()
+ stream.appendLine("#### Tips")
+ stream.appendLine()
+ stream.appendLine(
+ databaseHelper.getTips().joinToString { tip ->
+ tip.title
+ },
+ )
+
+ stream.appendLine()
+ stream.appendLine("### CI/CD")
+ stream.appendLine()
+ stream.appendLine("[Github Action](.github/workflows/android.yml) to automatically create a new Github release with APK and JAR and upload an AAB to the Play Store.")
+
+ stream.appendLine()
+ stream.appendLine("### Tests")
+ stream.appendLine()
+ stream.appendLine("Android Jetpack Compose screen tests: [ComposeTests.kt](android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeTests.kt)")
+ stream.appendLine()
+ stream.appendLine("Android Jetpack Compose deeplinking tests: [ComposeDeeplinkTests.kt](android/src/androidTest/java/com/inspiredandroid/linuxcommandbibliotheca/ComposeDeeplinkTests.kt)")
+ stream.appendLine()
+ stream.appendLine("Common code unit tests: [CommonTests.kt](common/src/commonTest/kotlin/CommonTests.kt)")
+
+ stream.appendLine()
+ stream.appendLine("### Licensing")
+ stream.appendLine()
+ stream.appendLine("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.")
+
+ stream.appendLine()
+ stream.appendLine("### Thanks to")
+ stream.appendLine()
+ stream.appendLine("http://letsgokoyo.com - App Icon")
+ stream.appendLine()
+ stream.appendLine("https://www.commandlinefu.com - Lots of one-liners")
+ stream.appendLine()
+ stream.appendLine("https://icons8.com - Icons")
+ stream.appendLine()
+ stream.appendLine("https://tldr.sh - TLDR")
+
+ stream.close()
+ }
+}
diff --git a/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/Minifier.kt b/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/Minifier.kt
new file mode 100644
index 0000000..ddbe02c
--- /dev/null
+++ b/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/Minifier.kt
@@ -0,0 +1,62 @@
+package com.linuxcommandlibrary.desktop
+
+import java.io.File
+import java.nio.file.Files
+
+class Minifier {
+
+ fun minifyScriptsAndSheets(isRelease: Boolean) {
+ val scriptsDir = File("html/scripts")
+ scriptsDir.mkdir()
+ val scripts = File("desktop/src/main/resources/scripts")
+ scripts.listFiles()?.forEach {
+ if (it.isFile) {
+ val file = File(scriptsDir, it.name)
+ file.delete()
+ if (isRelease) {
+ val minified = minifyJS(it.readText())
+ file.writeText(minified)
+ } else {
+ Files.createLink(file.toPath(), it.toPath())
+ }
+ }
+ }
+ val styleSheetsDir = File("html/stylesheets")
+ styleSheetsDir.mkdir()
+ val stylesheets = File("desktop/src/main/resources/stylesheets")
+ stylesheets.listFiles()?.forEach {
+ if (it.isFile) {
+ val file = File(styleSheetsDir, it.name)
+ file.delete()
+ if (isRelease) {
+ val minified = minifyCSS(it.readText())
+ file.writeText(minified)
+ } else {
+ Files.createLink(file.toPath(), it.toPath())
+ }
+ }
+ }
+ }
+
+ private fun minifyCSS(css: String): String = css.replaceWhiteSpacesBeforeAndAfter(";")
+ .replaceWhiteSpacesBeforeAndAfter("}")
+ .replaceWhiteSpacesBeforeAndAfter("\\{")
+ .replaceWhiteSpacesBeforeAndAfter(":")
+ .replaceWhiteSpacesBeforeAndAfter(",")
+
+ private fun minifyJS(js: String): String = js.replace("[\\n\\s].?//.*\\n".toRegex(), "") // will break if comment is after code
+ .replaceWhiteSpacesBeforeAndAfter(";")
+ .replaceWhiteSpacesBeforeAndAfter("}")
+ .replaceWhiteSpacesBeforeAndAfter("\\{")
+ .replaceWhiteSpacesBeforeAndAfter("=")
+ .replaceWhiteSpacesBeforeAndAfter("<")
+ .replaceWhiteSpacesBeforeAndAfter("-")
+ .replaceWhiteSpacesBeforeAndAfter(",")
+ .replaceWhiteSpacesBeforeAndAfter("\\+")
+ .replaceWhiteSpacesBeforeAndAfter("\\(")
+ .replaceWhiteSpacesBeforeAndAfter("\\)")
+ .replaceWhiteSpacesBeforeAndAfter("\\&")
+ .replaceWhiteSpacesBeforeAndAfter("\\>")
+
+ private fun String.replaceWhiteSpacesBeforeAndAfter(value: String): String = replace("\\s*$value\\s*".toRegex(), value)
+}
diff --git a/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/WebsiteBuilder.kt b/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/WebsiteBuilder.kt
new file mode 100644
index 0000000..b1a7975
--- /dev/null
+++ b/desktop/src/main/kotlin/com/linuxcommandlibrary/desktop/WebsiteBuilder.kt
@@ -0,0 +1,1490 @@
+package com.linuxcommandlibrary.desktop
+
+import com.linuxcommandlibrary.shared.CommandElement
+import com.linuxcommandlibrary.shared.databaseHelper
+import com.linuxcommandlibrary.shared.getCommandList
+import com.linuxcommandlibrary.shared.getHtmlFileName
+import com.linuxcommandlibrary.shared.getSortPriority
+import com.linuxcommandlibrary.shared.initDatabase
+import databases.BasicCategory
+import kotlinx.coroutines.async
+import kotlinx.html.ATarget
+import kotlinx.html.DIV
+import kotlinx.html.FlowContent
+import kotlinx.html.HEAD
+import kotlinx.html.HTMLTag
+import kotlinx.html.HtmlTagMarker
+import kotlinx.html.InputType
+import kotlinx.html.LINK
+import kotlinx.html.META
+import kotlinx.html.ScriptCrossorigin
+import kotlinx.html.UL
+import kotlinx.html.a
+import kotlinx.html.attributesMapOf
+import kotlinx.html.b
+import kotlinx.html.body
+import kotlinx.html.br
+import kotlinx.html.button
+import kotlinx.html.classes
+import kotlinx.html.div
+import kotlinx.html.footer
+import kotlinx.html.h1
+import kotlinx.html.h2
+import kotlinx.html.head
+import kotlinx.html.html
+import kotlinx.html.i
+import kotlinx.html.id
+import kotlinx.html.img
+import kotlinx.html.input
+import kotlinx.html.lang
+import kotlinx.html.li
+import kotlinx.html.link
+import kotlinx.html.nav
+import kotlinx.html.noScript
+import kotlinx.html.onClick
+import kotlinx.html.onKeyUp
+import kotlinx.html.p
+import kotlinx.html.script
+import kotlinx.html.span
+import kotlinx.html.stream.appendHTML
+import kotlinx.html.style
+import kotlinx.html.styleLink
+import kotlinx.html.table
+import kotlinx.html.td
+import kotlinx.html.title
+import kotlinx.html.tr
+import kotlinx.html.ul
+import kotlinx.html.unsafe
+import kotlinx.html.visit
+import org.json.JSONArray
+import org.json.JSONObject
+import java.io.File
+import java.io.PrintStream
+import java.util.Locale
+
+/* 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 main() {
+ initDatabase()
+
+ val minifier = Minifier()
+ val websiteBuilder = WebsiteBuilder()
+
+ val folder = File("html")
+ folder.mkdir()
+
+ websiteBuilder.createCommandsHtmlFile(folder)
+
+ websiteBuilder.createBasicsHtmlFile(folder)
+ websiteBuilder.createBasicHtmlFiles(File(folder, "basic"))
+
+ websiteBuilder.createTipsHtmlFile(folder)
+ websiteBuilder.createManHtmlFiles(File(folder, "man"))
+
+ websiteBuilder.create404HtmlFile()
+ websiteBuilder.createPrivacyPolicyHtmlFile(folder)
+ websiteBuilder.createContactHtmlFile(folder)
+ websiteBuilder.createTermsAndConditionsHtmlFile(folder)
+
+ websiteBuilder.createSitemap(folder)
+
+ minifier.minifyScriptsAndSheets(true)
+}
+
+class WebsiteBuilder {
+
+ private val cacheVersion = 11
+
+ private val h2Regex by lazy {
+ "(| " + } + if (it.data1.isNotBlank()) { + b { + text(it.data1) + } + } + unsafe { + +" | " + } + unsafe { + +""
+ }
+ if (it.extra.isNotBlank()) {
+ code(it.data2.replace("\\n", " "), it.extra) + } else { + text(it.data2) + } + unsafe { + +" |
![\"copy\"](\"/images/icon-copy.svg\"){kind=icon}