Skip to content

Commit

Permalink
switch from ESDoc to JSDoc for documentation
Browse files Browse the repository at this point in the history
also use a responsive template for the documentation website.
  • Loading branch information
lucaong committed Apr 25, 2020
1 parent 6d60d26 commit b5ca085
Show file tree
Hide file tree
Showing 85 changed files with 12,229 additions and 13,899 deletions.
31 changes: 0 additions & 31 deletions .esdoc.json

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
/examples/dist
/examples/node_modules
/coverage
yarn-error.log
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [![MiniSearch](https://lucaong.github.io/minisearch/MiniSearch.svg)](https://lucaong.github.io/minisearch/) MiniSearch
# MiniSearch

[![Build Status](https://travis-ci.org/lucaong/minisearch.svg?branch=master)](https://travis-ci.org/lucaong/minisearch)
[![Coverage Status](https://coveralls.io/repos/github/lucaong/minisearch/badge.svg?branch=master)](https://coveralls.io/github/lucaong/minisearch?branch=master)
Expand Down Expand Up @@ -299,7 +299,7 @@ The default term processor can be obtained by calling

### API Documentation

Refer to the [API documentation](https://lucaong.github.io/minisearch/identifiers.html)
Refer to the [API documentation](https://lucaong.github.io/minisearch/)
for details about configuration options and methods.


Expand All @@ -315,7 +315,7 @@ be used to provide those functions.
## Contributing

Contributions to `MiniSearch` are welcome! Please read the [contributions
guidelines](https://lucaong.github.io/minisearch/manual/CONTRIBUTING.html).
guidelines](https://github.com/lucaong/minisearch/CONTRIBUTING.html).
Reading the [design
document](https://lucaong.github.io/minisearch/manual/DESIGN_DOCUMENT.html) is
document](https://github.com/lucaong/minisearch/DESIGN_DOCUMENT.html) is
also useful to understand the project goals and the technical implementation.
Loading

0 comments on commit b5ca085

Please sign in to comment.