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
Run this command to download and install the latest version of `docs-builder`:
44
36
45
-
3.**Run the Binary:**
46
-
Use the `serve` command to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
47
37
```sh
48
-
./docs-builder serve -p ./path/to/docs
38
+
sudo curl -L https://raw.githubusercontent.com/elastic/docs-builder/refs/heads/main/install.sh | sh
49
39
```
40
+
41
+
This downloads the latest binary, makes it executable, and installs it to your user PATH.
50
42
51
-
:::
43
+
2.**Run docs-builder from a docs folder**
52
44
53
-
:::{tab-item} Windows
45
+
Use the `serve` command from any docs folder to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
54
46
55
-
1.**Download the Binary:**
56
-
Download the latest Windows binary from [releases](https://github.com/elastic/docs-builder/releases/latest/):
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
66
52
67
-
3.**Run the Binary:**
68
-
Use the `serve` command to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
69
-
70
-
```sh
71
-
.\docs-builder serve -p ./path/to/docs
72
-
```
53
+
If you get a `Permission denied` error, make sure that you aren't trying to run a directory instead of a file. Also, grant the binary file execution permissions using `chmod +x docs-builder`.
73
54
74
-
:::{tip}
75
-
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On Windows, you can do this by running `Copy-Item "docs-builder.exe" -Destination "%SystemRoot%\system32"` with elevated privileges, or move it to a new folder and add the folder to the system paths.
76
55
:::
77
56
78
-
:::
57
+
:::{tab-item} Windows
79
58
80
-
:::{tab-item} Linux
59
+
1.**Download and run the install script**
81
60
82
-
1.**Download the Binary:**
83
-
Download the latest Linux binary from [releases](https://github.com/elastic/docs-builder/releases/latest/):
Use the `serve` command to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
67
+
This downloads the latest binary, makes it executable, and installs it to your user PATH.
68
+
69
+
2.**Run docs-builder from a docs folder**
70
+
71
+
Use the `serve` command from any docs folder to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
72
+
96
73
```sh
97
-
./docs-builder serve -p ./path/to/docs
74
+
docs-builder serve
98
75
```
99
76
100
-
If you get a `Permission denied` error, make sure that you aren't trying to run a directory instead of a file. Also, grant the binary file execution permissions using `chmod +x docs-builder`.
101
-
102
-
:::{tip}
103
-
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On macOS and Linux, you can do this by running `sudo mv docs-builder /usr/local/bin/docs-builder`.
104
-
:::
77
+
To download and install the binary file manually, refer to [Releases](https://github.com/elastic/docs-builder/releases) on GitHub.
reader.EmitError($"Product \"{productId.Value}\" not found in the product list. {newSuggestion(Builder.Products.All.Select(p =>p.Id).ToHashSet(),productId.Value).GetSuggestionQuestion()}",node);
137
+
else
138
+
_=Products.Add(productId.Value);
139
+
}
140
+
break;
107
141
case"features":
108
142
_features=reader.ReadDictionary(entry.Entry).ToDictionary(k =>k.Key, v =>bool.Parse(v.Value),StringComparer.OrdinalIgnoreCase);
0 commit comments