-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Flesh out documentation around Python installs
- Loading branch information
Showing
3 changed files
with
66 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,25 +5,55 @@ nav_section: References | |
weight: 49 | ||
--- | ||
|
||
Pagefind is a static binary with no dynamic dependencies, so in most cases will be simple to install and run. Pagefind is currently supported on Windows, macOS, and x86-64 Linux distributions. | ||
Pagefind is a static binary with no dynamic dependencies, so in most cases will be simple to install and run. Pagefind is currently supported on Windows, macOS, and Linux distributions. | ||
|
||
## Running via npx | ||
|
||
For users with a NodeJS toolchain already installed, Pagefind publishes a [wrapper package through npm](https://www.npmjs.com/package/pagefind): | ||
|
||
```bash | ||
npx pagefind --site "public" | ||
``` | ||
|
||
Pagefind publishes a [wrapper package through npm](https://www.npmjs.com/package/pagefind), which is the easiest way to get started. This package will download the correct [binary of the latest release](https://github.com/CloudCannon/pagefind/releases) as an npm dependency for your platform and run it. | ||
This package includes the correct [binary of the relevant release](https://github.com/CloudCannon/pagefind/releases) as a dependency for your platform. | ||
|
||
Specific versions can be run by passing a version tag: | ||
|
||
```bash | ||
npx pagefind@latest --site "public" | ||
|
||
npx [email protected] --site "public" | ||
npx [email protected] --site "public" | ||
``` | ||
|
||
Running Pagefind via npx will always download the `pagefind_extended` release, which includes specialized support for indexing Chinese and Japanese pages. | ||
|
||
> Pagefind's npm package can also be imported and controlled from a script. See the [Node API documentation](/docs/node-api/) for details. | ||
## Running via Python | ||
|
||
For users with a Python toolchain already installed, Pagefind publishes a [wrapper package through pypi](https://pypi.org/project/pagefind/): | ||
|
||
```bash | ||
python3 -m pip install 'pagefind[extended]' | ||
python3 -m pagefind --site "public" | ||
``` | ||
|
||
This package includes the correct [binary of the relevant release](https://github.com/CloudCannon/pagefind/releases) as a dependency for your platform. | ||
|
||
Specific versions can be installed by passing a version: | ||
|
||
```bash | ||
python3 -m pip install 'pagefind[extended]==1.1.1' | ||
``` | ||
|
||
The above example shows installing the `pagefind_extended` release, which includes specialized support for indexing Chinese and Japanese pages. | ||
To install the smaller standard release, run: | ||
|
||
```bash | ||
python3 -m pip install 'pagefind[bin]' | ||
``` | ||
|
||
> Running Pagefind via npx will download the `pagefind_extended` release, which includes specialized support for indexing Chinese and Japanese pages. | ||
> Pagefind's Python package can also be imported and controlled from a script. See the [Python API documentation](/docs/py-api/) for details. | ||
## Downloading a precompiled binary | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters