Skip to content

Commit 736982f

Browse files
committed
update Quickstart guide
1 parent f10d592 commit 736982f

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

Guides/docs.docc/Quickstart.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ Today, there are two main ways to install Unidoc — building it from source or
2424

2525
Pre-built binaries are available for a limited set of platforms.
2626

27-
| Platform | Download |
27+
| Platform | String |
2828
|----------|----------|
29-
| macOS | [`macOS-ARM64/unidoc.tar.gz`](https://static.swiftinit.org/unidoc/0.19.0/macOS-ARM64/unidoc.tar.gz) |
30-
| Linux | [`Linux-X64/unidoc.tar.gz`](https://static.swiftinit.org/unidoc/0.19.0/Linux-X64/unidoc.tar.gz) |
29+
| macOS | `macOS-ARM64` |
30+
| Linux | `Linux-X64` |
3131

3232

33-
You can download and install the binary in your home directory like this:
33+
You can download and install the binary under `/usr/local/bin` like this:
3434

3535
@Code(file: unidoc-install.sh, title: unidoc-install.sh)
3636

@@ -42,10 +42,6 @@ Unidoc is an ordinary SwiftPM executable product. You can build it for your macO
4242
@Code(file: unidoc-from-source.sh, title: unidoc-from-source.sh)
4343

4444

45-
> Important:
46-
> The rest of this guide assumes you have installed Unidoc somewhere on your macOS host that is visible in your `PATH` and allows you to invoke it as `unidoc`.
47-
48-
4945
## 3. Launching a `mongod` instance
5046

5147
Unidoc can configure a `mongod` instance for you through the `unidoc init` command. This tool takes a directory path as an argument, which it uses to persist the state of the database. In the example below, we will create the documentation database in a directory named `unidoc` in your home directory.
@@ -63,14 +59,16 @@ Please note that this will start a Docker container that runs continuously in th
6359

6460
## 3. Running `unidoc preview`
6561

66-
The `unidoc preview` tool is a simple web server that links and serves documentation for local Swift packages. Run it directly from your macOS host like this:
62+
The `unidoc preview` tool is a simple web server that links and serves documentation for local Swift packages. Run it directly from the host like this:
6763

6864
```bash
6965
unidoc preview
7066
```
7167

7268
The `unidoc preview` tool will start a web server on [`http://localhost:8080`](http://localhost:8080).
7369

70+
Please note that to serve the necessary CSS and JavaScript the server expects to find the `Assets` directory in the current working directory. These resources are included in the `unidoc.tar.gz` archives, and if built from source, they are also available in the `swift-unidoc` repository.
71+
7472
@Image(source: "Start page.png", alt: "Start page") {
7573
> The `unidoc preview` start page.
7674
}

Guides/docs.docc/local/unidoc-from-source.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ mkdir -p ~/unidoc/bin
22
git clone https://github.com/tayloraswift/swift-unidoc
33
cd swift-unidoc
44
swift build -c release --product unidoc
5-
mv .build/release/unidoc ~/unidoc/bin/unidoc
5+
mv .build/release/unidoc /usr/local/bin/unidoc

0 commit comments

Comments
 (0)