You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Guides/docs.docc/Getting started.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ A fresh Unidoc database contains no documentation. Let’s build some now.
94
94
95
95
The documentation compiler lives in this repository, and is packaged as a normal SwiftPM executable target.
96
96
97
-
To invoke the compiler, run the `unidoc-build` tool and pass it the name of the package you want to build documentation for. In our case, the “package” is `swift`, which is a special name identifying the standard library itself.
97
+
To invoke the compiler, run the `unidoc local` tool and pass it the name of the package you want to build documentation for. In our case, the “package” is `swift`, which is a special name identifying the standard library itself.
**Where** you clone the repository is important, because you will need to tell Unidoc where to find the project. In this example, we cloned the repository inside a directory called `/swift`, which is a plausible place to store Git repositories in a devcontainer.
132
132
133
-
Next, you can try building `swift-nio` with `unidoc-build`, specifying the path to the search directory (`/swift`) with the `-I` option.
133
+
Next, you can try building `swift-nio` with `unidoc local`, specifying the path to the search directory (`/swift`) with the `-I` option.
Copy file name to clipboardExpand all lines: Guides/docs.docc/Quickstart.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Previewing documentation locally
2
2
3
-
This guide walks through how to use the `unidoc-preview` tool to preview documentation locally on macOS 14. This guide won’t make any effort to explain how Unidoc itself works, it is merely intended to demonstrate how to preview multi-package documentation as quickly as possible. For a more-detailed Linux-centric tour, see the <doc:Getting-started> guide.
3
+
This guide walks through how to use the `unidocpreview` tool to preview documentation locally on macOS 14. This guide won’t make any effort to explain how Unidoc itself works, it is merely intended to demonstrate how to preview multi-package documentation as quickly as possible. For a more-detailed Linux-centric tour, see the <doc:Getting-started> guide.
4
4
5
5
In this guide, you will:
6
6
7
7
1. Launch and initialize a `mongod` instance in a Docker container,
8
-
2. Build and run an instance of `unidoc-preview` on the macOS host,
9
-
3. Build the `unidoc-build` tool,
8
+
2. Build and run an instance of `unidocpreview` on the macOS host,
9
+
3. Build the `unidoc local` tool,
10
10
4. Generate documentation for the standard library, and
11
11
5. Generate documentation for two SwiftPM packages, one of which depends on the other.
## 4. Generating documentation for the standard library
62
62
63
-
Generate local documentation using the `unidoc-build local` subcommand. To start off, open a third terminal and generate the documentation for the standard library (`swift`).
63
+
Generate local documentation using the `unidoc local` subcommand. To start off, open a third terminal and generate the documentation for the standard library (`swift`).
Generating documentation for a package is similar to generating documentation for the standard library, except you need to specify a search path to a directory containing the project. Because you downloaded the `swift-collections` repository to a sibling directory, you can use `..` for the search path.
85
85
86
86
```bash
87
-
swift run -c release unidoc-buildlocal swift-collections -I ..
87
+
swift run -c release unidoc-toolslocal swift-collections -I ..
88
88
```
89
89
90
90
You should be able to view the symbol graph and its documentation at [`http://localhost:8080/tags/swift-collections`](http://localhost:8080/tags/swift-collections).
@@ -99,7 +99,7 @@ Finally, let’s generate documentation for a package that depends on `swift-col
0 commit comments