mirror of
https://github.com/rowtype-yoga/purescript-docs-search.git
synced 2024-09-11 12:35:37 +03:00
Update badge (#64)
Co-authored-by: Fabrizio Ferrai <fabrizio.ferrai@gmail.com>
This commit is contained in:
parent
2e294fb70c
commit
57ff86d84c
@ -1,8 +1,8 @@
|
|||||||
# purescript-docs-search
|
# purescript-docs-search
|
||||||
|
|
||||||
[![Build status](https://travis-ci.org/spacchetti/purescript-docs-search.svg?branch=master)](https://travis-ci.org/spacchetti/purescript-docs-search)
|
[![Build status](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml/badge.svg)](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml)
|
||||||
|
|
||||||
An app that adds search capabilities to generated documentation for purescript code.
|
An app that adds search capabilities to generated documentation for PureScript code.
|
||||||
|
|
||||||
It supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.
|
It supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.
|
||||||
|
|
||||||
@ -10,7 +10,7 @@ It supports nearly-all functionality of [Pursuit](https://github.com/purescript/
|
|||||||
|
|
||||||
When using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.
|
When using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.
|
||||||
|
|
||||||
Otherwise, use [npx](https://github.com/npm/npx): `npx purescript-docs-search`.
|
Otherwise, use NPM (`npm install purescript-docs-search`) or [npx](https://github.com/npm/npx): `npx purescript-docs-search`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -45,4 +45,4 @@ npm install
|
|||||||
npm run build # or build-dev to skip JS compression stage
|
npm run build # or build-dev to skip JS compression stage
|
||||||
```
|
```
|
||||||
|
|
||||||
Use `spago docs --no-search && ./dist/purescript-docs-search build-index` to generate the docs and patch them using the local version of the app.
|
Use `spago docs --no-search && ./dist/purescript-docs-search.cjs build-index` to generate the docs and patch them using the local version of the app.
|
||||||
|
Loading…
Reference in New Issue
Block a user