A simple CLI tool for publishing Crystal Shard documentation to crystal-docs.org. It is a requirement that users have first identified themselves on the website before they are able to publish.
The tool is just a convenient wrapper for rsync, so you must also have that installed.
Requires crystal-lang 0.18.7+
git clone [email protected]:barisbalic/crystal-docs-cli.git
cd crystal-docs-cli
shards install
crystal build --release src/crystal-docs.cr
The first step is to publish the current documentation for your Shard.
crystal-docs publishOnce you have done this, you may publish docs for a specific version...
crystal-docs publish 0.1.0Or... for a branch/tag.
crystal-docs publish rc1Optionally you may generate documentation before pushing...
crystal-docs publish -gShould you need to publish docs as another user, you may specify a user with the -u flag.
crystal-docs publish -u lemondrizzle- Fork it ( https://github.com/barisbalic/crystal-docs/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
- barisbalic Baris Balic - creator, maintainer