mirror of
https://github.com/zadam/trilium.git
synced 2026-02-07 22:34:24 +01:00
docs(user): add nightly release script for Windows
Some checks are pending
Checks / main (push) Waiting to run
CodeQL Advanced / Analyze (actions) (push) Waiting to run
CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run
Deploy Documentation / Build and Deploy Documentation (push) Waiting to run
Dev / Test development (push) Waiting to run
Dev / Build Docker image (push) Blocked by required conditions
Dev / Check Docker build (Dockerfile) (push) Blocked by required conditions
Dev / Check Docker build (Dockerfile.alpine) (push) Blocked by required conditions
/ Check Docker build (Dockerfile) (push) Waiting to run
/ Check Docker build (Dockerfile.alpine) (push) Waiting to run
/ Build Docker images (Dockerfile, ubuntu-24.04-arm, linux/arm64) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.alpine, ubuntu-latest, linux/amd64) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v7) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v8) (push) Blocked by required conditions
/ Merge manifest lists (push) Blocked by required conditions
playwright / E2E tests on linux-arm64 (push) Waiting to run
playwright / E2E tests on linux-x64 (push) Waiting to run
Some checks are pending
Checks / main (push) Waiting to run
CodeQL Advanced / Analyze (actions) (push) Waiting to run
CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run
Deploy Documentation / Build and Deploy Documentation (push) Waiting to run
Dev / Test development (push) Waiting to run
Dev / Build Docker image (push) Blocked by required conditions
Dev / Check Docker build (Dockerfile) (push) Blocked by required conditions
Dev / Check Docker build (Dockerfile.alpine) (push) Blocked by required conditions
/ Check Docker build (Dockerfile) (push) Waiting to run
/ Check Docker build (Dockerfile.alpine) (push) Waiting to run
/ Build Docker images (Dockerfile, ubuntu-24.04-arm, linux/arm64) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.alpine, ubuntu-latest, linux/amd64) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v7) (push) Blocked by required conditions
/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v8) (push) Blocked by required conditions
/ Merge manifest lists (push) Blocked by required conditions
playwright / E2E tests on linux-arm64 (push) Waiting to run
playwright / E2E tests on linux-x64 (push) Waiting to run
This commit is contained in:
parent
fbe5152cb3
commit
72d6b83ec5
@ -26,10 +26,35 @@
|
||||
<h2>Automatically download and install the latest nightly</h2>
|
||||
<p>This is pretty useful if you are a beta tester that wants to periodically
|
||||
update their version:</p>
|
||||
<p>On Ubuntu:</p><pre><code class="language-text-x-trilium-auto">#!/usr/bin/env bash
|
||||
<h2>On Ubuntu (Bash)</h2><pre><code class="language-text-x-sh">#!/usr/bin/env bash
|
||||
|
||||
name=TriliumNotes-linux-x64-nightly.deb
|
||||
rm -f $name*
|
||||
wget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name
|
||||
sudo apt-get install ./$name
|
||||
rm $name</code></pre>
|
||||
rm $name</code></pre>
|
||||
<h2>On Windows (PowerShell)</h2><pre><code class="language-application-x-powershell">if ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") {
|
||||
$arch = "arm64";
|
||||
} else {
|
||||
$arch = "x64";
|
||||
}
|
||||
|
||||
$exeUrl = "https://github.com/TriliumNext/Trilium/releases/download/nightly/TriliumNotes-main-windows-$($arch).exe";
|
||||
Write-Host "Downloading $($exeUrl)"
|
||||
|
||||
# Generate a unique path in the temp dir
|
||||
$guid = [guid]::NewGuid().ToString()
|
||||
$destination = Join-Path -Path $env:TEMP -ChildPath "$guid.exe"
|
||||
|
||||
try {
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
Invoke-WebRequest -Uri $exeUrl -OutFile $destination
|
||||
$process = Start-Process -FilePath $destination
|
||||
} catch {
|
||||
Write-Error "An error occurred: $_"
|
||||
} finally {
|
||||
# Clean up
|
||||
if (Test-Path $destination) {
|
||||
Remove-Item -Path $destination -Force
|
||||
}
|
||||
}</code></pre>
|
||||
@ -24,8 +24,7 @@
|
||||
<li>click on an image or link and save it through context menu</li>
|
||||
<li>save whole page from the popup or context menu</li>
|
||||
<li>save screenshot (with crop tool) from either popup or context menu</li>
|
||||
<li
|
||||
>create short text note from popup</li>
|
||||
<li>create short text note from popup</li>
|
||||
</ul>
|
||||
<h2>Location of clippings</h2>
|
||||
<p>Trilium will save these clippings as a new child note under a "clipper
|
||||
@ -40,10 +39,8 @@
|
||||
<p>Keyboard shortcuts are available for most functions:</p>
|
||||
<ul>
|
||||
<li>Save selected text: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li>
|
||||
<li
|
||||
>Save whole page: <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌥</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li>
|
||||
<li
|
||||
>Save screenshot: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>E</kbd>)</li>
|
||||
<li>Save whole page: <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌥</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li>
|
||||
<li>Save screenshot: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>E</kbd>)</li>
|
||||
</ul>
|
||||
<p>To set custom shortcuts, follow the directions for your browser.</p>
|
||||
<ul>
|
||||
@ -72,20 +69,19 @@
|
||||
<li><a href="https://github.com/TriliumNext/Trilium/releases">GitHub Releases</a> by
|
||||
looking for releases starting with <em>Web Clipper.</em>
|
||||
</li>
|
||||
<li>Artifacts in GitHub Actions, by looking for the <a href="https://github.com/TriliumNext/Trilium/actions/workflows/web-clipper.yml"><em>Deploy web clipper extension </em>workflow</a>.
|
||||
<li>Artifacts in GitHub Actions, by looking for the <a href="https://github.com/TriliumNext/Trilium/actions/workflows/web-clipper.yml"><em>Deploy web clipper extension</em> workflow</a>.
|
||||
Once a workflow run is selected, the ZIP files are available in the <em>Artifacts</em> section,
|
||||
under the name <code spellcheck="false">web-clipper-extension</code>.</li>
|
||||
</ul>
|
||||
<h3>For Chrome</h3>
|
||||
<ol>
|
||||
<li>Download <code spellcheck="false">trilium-web-clipper-[x.y.z]-chrome.zip</code>.</li>
|
||||
<li
|
||||
>Extract the archive.</li>
|
||||
<li>In Chrome, navigate to <code spellcheck="false">chrome://extensions/</code>
|
||||
</li>
|
||||
<li>Toggle <em>Developer Mode</em> in top-right of the page.</li>
|
||||
<li>Press the <em>Load unpacked</em> button near the header.</li>
|
||||
<li>Point to the extracted directory from step (2).</li>
|
||||
<li>Extract the archive.</li>
|
||||
<li>In Chrome, navigate to <code spellcheck="false">chrome://extensions/</code>
|
||||
</li>
|
||||
<li>Toggle <em>Developer Mode</em> in top-right of the page.</li>
|
||||
<li>Press the <em>Load unpacked</em> button near the header.</li>
|
||||
<li>Point to the extracted directory from step (2).</li>
|
||||
</ol>
|
||||
<h3>For Firefox</h3>
|
||||
<aside class="admonition warning">
|
||||
@ -100,12 +96,10 @@
|
||||
<li>Navigate to <code spellcheck="false">about:addons</code>.</li>
|
||||
<li>Select <em>Extensions</em> in the left-side navigation.</li>
|
||||
<li>Press the <em>Gear</em> icon on the right of the <em>Manage Your Extensions</em> title.</li>
|
||||
<li
|
||||
>Select <em>Install Add-on From File…</em>
|
||||
</li>
|
||||
<li>Point it to <code spellcheck="false">trilium-web-clipper-[x.y.z]-firefox.zip</code>.</li>
|
||||
<li
|
||||
>Press the <em>Add</em> button to confirm.</li>
|
||||
<li>Select <em>Install Add-on From File…</em>
|
||||
</li>
|
||||
<li>Point it to <code spellcheck="false">trilium-web-clipper-[x.y.z]-firefox.zip</code>.</li>
|
||||
<li>Press the <em>Add</em> button to confirm.</li>
|
||||
</ol>
|
||||
<h2>Credits</h2>
|
||||
<p>Some parts of the code are based on the <a href="https://github.com/laurent22/joplin/tree/master/Clipper">Joplin Notes browser extension</a>.</p>
|
||||
@ -1,5 +1,5 @@
|
||||
# Documentation
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/jaeLd6kJGrRa/Documentation_image.png" width="205" height="162">
|
||||
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/JWpRkGvOzpu3/Documentation_image.png" width="205" height="162">
|
||||
|
||||
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
|
||||
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
|
||||
|
||||
@ -21,9 +21,9 @@ Depending on your use case, you can either test the portable version or even use
|
||||
|
||||
This is pretty useful if you are a beta tester that wants to periodically update their version:
|
||||
|
||||
On Ubuntu:
|
||||
## On Ubuntu (Bash)
|
||||
|
||||
```
|
||||
```sh
|
||||
#!/usr/bin/env bash
|
||||
|
||||
name=TriliumNotes-linux-x64-nightly.deb
|
||||
@ -31,4 +31,34 @@ rm -f $name*
|
||||
wget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name
|
||||
sudo apt-get install ./$name
|
||||
rm $name
|
||||
```
|
||||
|
||||
## On Windows (PowerShell)
|
||||
|
||||
```powershell
|
||||
if ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") {
|
||||
$arch = "arm64";
|
||||
} else {
|
||||
$arch = "x64";
|
||||
}
|
||||
|
||||
$exeUrl = "https://github.com/TriliumNext/Trilium/releases/download/nightly/TriliumNotes-main-windows-$($arch).exe";
|
||||
Write-Host "Downloading $($exeUrl)"
|
||||
|
||||
# Generate a unique path in the temp dir
|
||||
$guid = [guid]::NewGuid().ToString()
|
||||
$destination = Join-Path -Path $env:TEMP -ChildPath "$guid.exe"
|
||||
|
||||
try {
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
Invoke-WebRequest -Uri $exeUrl -OutFile $destination
|
||||
$process = Start-Process -FilePath $destination
|
||||
} catch {
|
||||
Write-Error "An error occurred: $_"
|
||||
} finally {
|
||||
# Clean up
|
||||
if (Test-Path $destination) {
|
||||
Remove-Item -Path $destination -Force
|
||||
}
|
||||
}
|
||||
```
|
||||
Loading…
x
Reference in New Issue
Block a user