Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freetonik/quickref.dev
Quickref.dev community sources
https://github.com/freetonik/quickref.dev
Last synced: 7 days ago
JSON representation
Quickref.dev community sources
- Host: GitHub
- URL: https://github.com/freetonik/quickref.dev
- Owner: freetonik
- Created: 2020-01-31T08:03:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-16T06:58:28.000Z (over 4 years ago)
- Last Synced: 2024-11-28T09:40:20.091Z (2 months ago)
- Language: Makefile
- Size: 59.6 KB
- Stars: 116
- Watchers: 4
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This project was shut down in September 2020.
---
# Quickref.dev Community Sources
This repo contains data sources for Quickref.dev — a community-driven search engine for software developers. `sites` contains lists of sites to index, grouped by category. `cards` contains reference cards ([example in action](https://quickref.dev/search?q=clojure&type=all)).
## Contributing
Please, create a pull request to:
- add a site to the index
- add or modify a reference card.
I you want to add a new bang operator (`!foo`), please, create an issue.
Thank you.
## Sites
There are 5 categories of search on Quickref.dev. Each corresponds to a .txt-file of indexed sites:
- All (`all.txt`)
- Docs (`docs.txt`)
- Forums / Q&A (`forums_qa.txt`)
- Blogs (`blogs.txt`)
- Repositories (`repositories.txt`)
Category "All" is compiled automatically by combining all other categories. Quickref.dev searches in all subdomains, regardless of depth. For example, if `https://abc.com` is specified, all existing subdomains (`https://x.abc.com`, `https://y.x.abc.com`, etc) are indexed and searched.
## Cards
Each card is structured as follows:
``` yaml
"list of words":
name: "Name"
description: "Short one sentence description."
links:
website: "https://official_website.com"
quickstart: "https://official_website.com/getting_started"
"community docs": "https://clojuredocs.org/"
"Mailing list": "https://groups.google.com/forum/..."
subreddit: "https://reddit.com/r/..."
...
```
The `"list of words"` is used to match cards to queries. A card is displayed if the user's query contains at least one of the specified words (case insensitive). For example, requests `clojure`, `clj`, `clj list` or `clojure map` will all match this card:
``` yaml
"clojure clj":
name: "Clojure"
description: "Dynamically typed, functional dialect of Lisp. Immutable values, strong typing, hosted on JVM and other platforms."
links:
website: "https://clojure.org/"
quickstart: "https://clojure.org/guides/getting_started"
"community docs": "https://clojuredocs.org/"
"Learn in Y minutes": "https://learnxinyminutes.com/docs/clojure/"
"Q&A forum": "https://ask.clojure.org/"
"Clojurians Slack": "https://clojurians.herokuapp.com/"
"Mailing list": "https://groups.google.com/forum/#!forum/clojure"
subreddit: "https://old.reddit.com/r/Clojure/"
```