diff --git a/.github/workflows/publish-wiki.yaml b/.github/workflows/publish-wiki.yaml index c272b49e..8b03de76 100644 --- a/.github/workflows/publish-wiki.yaml +++ b/.github/workflows/publish-wiki.yaml @@ -58,7 +58,6 @@ jobs: run: | hugo \ --gc \ - --minify \ --baseURL "${{ steps.pages.outputs.base_url }}/" - name: Upload artifact uses: actions/upload-pages-artifact@v2 diff --git a/docs/site/content/_index.en.md b/docs/site/content/_index.en.md index b81bee99..6b25f361 100644 --- a/docs/site/content/_index.en.md +++ b/docs/site/content/_index.en.md @@ -2,13 +2,13 @@ https://github.com/mlopatkin/andlogview -Android log viewer is the tool to simplify analysis of the Android logs. +Android log viewer is the tool to simplify analysis of the Android logs, both +live from a device or an emulator, or log and dumpstate files. -![Application window](https://bitbucket.org/mlopatkin/android-log-viewer/wiki/multiple_filters.png) +![Application window](andlogview.png) -![](/adb_setup_prompt.png) -## Features + diff --git a/docs/site/content/adb_mode/_index.en.md b/docs/site/content/adb_mode/_index.en.md index 4400c6bf..bf34f1fd 100644 --- a/docs/site/content/adb_mode/_index.en.md +++ b/docs/site/content/adb_mode/_index.en.md @@ -1,8 +1,9 @@ --- title: Working with a device or an emulator +weight: 30 --- -Logviewer can display logs directly from an emulator or a device if you have -the Android SDK installed. Simply run a launching script and the Logviewer +AndLogView can display logs directly from an emulator or a device if you have +the Android SDK installed. Simply run a launching script and the AndLogView will try to connect to the first available device in the "adb devices" list. If there is no available devices the tool will be waiting for a device to connect. diff --git a/docs/site/content/andlogview.png b/docs/site/content/andlogview.png new file mode 100644 index 00000000..a9ef53e4 Binary files /dev/null and b/docs/site/content/andlogview.png differ diff --git a/docs/site/content/features/_index.en.md b/docs/site/content/features/_index.en.md new file mode 100644 index 00000000..89a2fb14 --- /dev/null +++ b/docs/site/content/features/_index.en.md @@ -0,0 +1,14 @@ +--- +title: Features +weight: 10 +--- + +* [Display logs from a device or an emulator](/adb_mode) +* Display saved logs and dumpstate files +* Search in the logs using regex if needed +* Filter log lines by tag, PID, log priority, message content + * Filtered lines can be hidden, highlighted or shown in a separate window +* Bookmarks +* Display any avaliable buffers: main, system, events, radio +* Save filtered lines +* Display process list diff --git a/docs/site/content/install/_index.en.md b/docs/site/content/install/_index.en.md new file mode 100644 index 00000000..45feae74 --- /dev/null +++ b/docs/site/content/install/_index.en.md @@ -0,0 +1,33 @@ +--- +title: Installation +weight: 20 +--- + +## Requirements +* Windows, Linux, or MacOS X +* JRE or JDK 8+ +* Android SDK (optional, to work with a device or an emulator) + +The Java executable (`javaw.exe` on Windows and `java` on Linux/MacOS X) is +expected to be on `PATH`. Alternatively, the `JAVA_HOME` environment variable +should point to the JRE/JDK. + +## Installing + +Download the [latest release archive](https://github.com/mlopatkin/andlogview/releases/latest) from the GitHub, and unpack it into the location of your +choice. + +To run the logview, use the OS-specific script: +* `bin/logview.bat` (Windows) +* `bin/logview` (Linux/MacOS X) + + diff --git a/docs/site/content/license/_index.md b/docs/site/content/license/_index.md index 4bb3bd2a..23defdaf 100644 --- a/docs/site/content/license/_index.md +++ b/docs/site/content/license/_index.md @@ -1,6 +1,6 @@ --- title: License -weight: 100 +weight: 1000 --- ``` Apache License diff --git a/docs/site/data/menu/more.yaml b/docs/site/data/menu/more.yaml index 504d78b1..2f9eb2d5 100644 --- a/docs/site/data/menu/more.yaml +++ b/docs/site/data/menu/more.yaml @@ -4,3 +4,7 @@ more: ref: "https://github.com/mlopatkin/andlogview/releases" external: true icon: "gdoc_download" + - name: Mailing list + ref: "https://groups.google.com/g/android-log-viewer" + external: true + icon: "gdoc_email" diff --git a/docs/site/i18n/en.yaml b/docs/site/i18n/en.yaml new file mode 100644 index 00000000..6ffd2cfc --- /dev/null +++ b/docs/site/i18n/en.yaml @@ -0,0 +1,2 @@ +--- +nav_navigation: Contents