staticsearch
A codebase to support a pure JSON search engine requiring no backend for any XHTML5 document collection
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.5%) to scientific vocabulary
Keywords
Repository
A codebase to support a pure JSON search engine requiring no backend for any XHTML5 document collection
Basic Info
- Host: GitHub
- Owner: projectEndings
- License: mpl-2.0
- Language: HTML
- Default Branch: dev
- Homepage: https://endings.uvic.ca/staticSearch/docs/index.html
- Size: 65.2 MB
Statistics
- Stars: 59
- Watchers: 4
- Forks: 22
- Open Issues: 44
- Releases: 16
Topics
Metadata Files
README.md
staticSearch
A codebase to support a pure JSON search engine requiring no backend for any XHTML5 document collection
This codebase, developed by Joey Takeda and Martin Holmes, provides a configurable, customizable tool which you can point at an XHTML5 document collection and have it generate a search page which requires no backend server-side component. It creates stemmed indexes of all document text, along with an HTML search page including faceted search features based on <meta> tags in the document collection. The search page uses pure JavaScript to query the index, which is a large collection of small JSON files, to provide a rapid and sophisticated search for any small-to-medium website. The search does not require any server-side code at all.
The generation code uses XSLT3 and the search functionality is JavaScript. Implementations of the Porter2 stemmer in XSLT and JavaScript are part of the package. Live search pages based on this code are already in use in the sites Mapping Keats's Progress, The Map of Early Modern London and The Winnifred Eaton Archive.
The default branch of this repo is the dev branch; the main branch is used for releases. Formal releases started in early 2020, and the main branch will always reflect the latest release tag, so you can pin your own project either to master or to a specific release tag to avoid unexpected changes in behaviour due to codebase changes. For testing to prepare for upcoming changes, you can use the dev branch. Releases are also archived on Zenodo:
Full documentation can be found in the file docs/staticSearch.html. Live searchable documentation (built using staticSearch) for the latest release can be found at the Project Endings site.
Please report all issues you encounter as tickets on the repo.
The code is licensed under both MPL and BSD.
Owner
- Name: projectEndings
- Login: projectEndings
- Kind: organization
- Repositories: 7
- Profile: https://github.com/projectEndings
GitHub Events
Total
- Create event: 16
- Release event: 1
- Issues event: 36
- Watch event: 7
- Delete event: 8
- Issue comment event: 105
- Push event: 78
- Pull request event: 19
Last Year
- Create event: 16
- Release event: 1
- Issues event: 36
- Watch event: 7
- Delete event: 8
- Issue comment event: 105
- Push event: 78
- Pull request event: 19
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 19
- Total pull requests: 9
- Average time to close issues: 9 months
- Average time to close pull requests: 6 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 3.37
- Average comments per pull request: 0.56
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 16
- Pull requests: 9
- Average time to close issues: about 1 month
- Average time to close pull requests: 6 days
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 2.38
- Average comments per pull request: 0.56
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- martindholmes (33)
- joeytakeda (9)
- peterrobinson (2)
- sydb (1)
Pull Request Authors
- martindholmes (18)
- joeytakeda (5)
- sydb (1)