https://github.com/opal/docs

https://github.com/opal/docs

docs opal ruby

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/opal/docs
• Owner: opal
• Created: 2015-07-18T13:36:10.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T09:20:07.000Z (over 1 year ago)
• Last Synced: 2025-03-28T07:51:14.003Z (11 months ago)
• Topics: docs, opal, ruby
• Language: HTML
• Homepage: https://opal.github.io/docs
• Size: 44.9 MB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Opal Documentation Central

This repo will hold the keys for generating Opal API documentation and guides on the `master` branch, while the `gh-pages` branch will keep track of the generated docs. The source for the docs will be the Opal repo itself.

[![documentation: Opal API](http://img.shields.io/badge/API%20documentation-read%20now-blue.svg)](https://opal.github.io/docs/index.html)

### Generating docs for a single version

The passed version needs to be a valid git ref (e.g. a tag)

    bin/build v0.5.5

    bin/build master

### Rebuilding all the docs

    bin/build-all

### Previewing locally

    bin/server # will use port 5000

### Publishing (only with commit access)

    bin/deploy