Popularity
3.9
Declining
Activity
0.0
Stable
8
4
2
Programming language: Crystal
License: MIT License
Tags:
Misc
Latest version: v0.1.0
crdoc alternatives and similar shards
Based on the "Misc" category.
Alternatively, view crdoc alternatives based on common mentions on social networks and blogs.
-
sentry
Build/Runs your crystal application, watches files, and rebuilds/restarts app on file changes -
immutable
Thread-safe, persistent, immutable collections for the Crystal language -
crystal-web-framework-stars
โญ๏ธ Web frameworks for Crystal, most starred on Github -
cron_scheduler
Simple job scheduler with crontab patterns for Crystal Language. -
inflector.cr
Inflector shard for Crystal. A port of ActiveSupport::Inflector -
aasm.cr
:arrows_clockwise: Easy to use finite state machine for Crystal classes -
kreal
Kreal is a model sharing & RPC library built on and works with Kemal seamlessly. -
ulid
Universally Unique Lexicographically Sortable Identifier (ULID) in Crystal -
CrSerializer
Extensible annotation based serialization/deserialization library -
circuit_breaker
Implementation of the circuit breaker pattern in crystal -
burocracia.cr
๐ Zero-dependency Crystal shard to validate, generate and format Brazilian burocracias (CPF, CNPJ, CEP) -
wikicr
Wiki in crystal, using Markdown and Git, inspired by dokuwiki. Last features to build are pretty hard, if you have some time to help... :) -
m3u8
Generate and parse m3u8 playlists for HTTP Live Streaming (HLS) in Crystal. -
message_verifier.cr
Rails compatible MessageVerifier for Crystal-lang apps -
defined
This shard provides facilities for checking whether a constant exists at compile time, and for a variety of different conditional compilation options. Code can be conditionally compiled based on the existence of a constant, version number constraints, or whether an environment variable is set truthy or not.
Clean code begins in your IDE with SonarLint
Up your coding game and discover issues early. SonarLint is a free plugin that helps you find & fix bugs and security issues from the moment you start writing code. Install from your favorite IDE marketplace today.
Promo
www.sonarlint.org
Do you think we are missing an alternative of crdoc or a related project?
README
crdoc
crdoc
is a CLI tool to search and open documentation for Crystal language.
Installation
Please download a binary from release page (OS X only) or build
$ cd /your/favorite/directory/
$ git clone https://github.com/rhysd/crdoc.git && cd crdoc
$ git submodule update
$ crystal build --release bin/crdoc.cr
$ cp crdoc /your/favorite/bin
Usage
crdoc search [-f] KEYWORD...
crdoc api [-f] KEYWORD...
crdoc syntax_and_semantics [-f] KEYWORD...
crdoc list [-p|--path] [-a|--api] [-s|--syntax-and-semantics]
crdoc update
search
searches all documents with keyword(s) and show the result in browser.api
searches API document with keyword(s) and show the result in browser.syntax_and_semantics
searches 'syntax and semantics' document with keyword(s) and show the result in browser.list
shows list of candidates. When--path
is specified, it shows full paths to HTML documents instead.update
updates cached repository.
Using with peco/percol
If you want to search documents incrementally, awesome filtering tools are available. You can use them as below (OS X example)
$ open "$(crdoc list --path | peco)"
$ open "$(crdoc list --path | percol)"
If you often use these commands, it is also handy to make a function or an alias. Below is a Zsh & peco example.
function peco-crdoc() {
local open
case $OSTYPE in
darwin*)
open="open"
;;
linux*)
open="xdg-open"
;;
esac
local selected=$(crdoc list --path | peco --prompt 'crdoc >' --query "$LBUFFER")
if [ -n "$selected" ]; then
$open "${selected}"
fi
zle clear-screen
}
zle -N peco-crdoc
TODOs
- Show markdown document in CLI instead of opening with browser
- 'syntax and semantics' markdown documents already exists
- It is necessary to generate markdown document from inline documents in comment
- Add
--browser
option to preserve current features
- Ignore-case match
Development
- Crystal v0.11.0
Contributing
- Fork it ( https://github.com/rhysd/crdoc/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
- @rhysd - creator, maintainer