https://github.com/alpacahq/alpaca-docs

Developer documentation for Alpaca API's
https://github.com/alpacahq/alpaca-docs

broker-api crypto docs hugo market-data stocks-api trading-api

Last synced: about 2 months ago
JSON representation

Developer documentation for Alpaca API's

• Host: GitHub
• URL: https://github.com/alpacahq/alpaca-docs
• Owner: alpacahq
• Created: 2022-01-26T20:42:24.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T19:11:26.000Z (over 1 year ago)
• Last Synced: 2024-05-21T05:13:05.326Z (8 months ago)
• Topics: broker-api, crypto, docs, hugo, market-data, stocks-api, trading-api
• Language: HTML
• Homepage: https://alpaca.markets/docs
• Size: 15.2 MB
• Stars: 14
• Watchers: 32
• Forks: 41
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# alpaca-docs

Developer documentation for Alpaca API's.

## Requirements

- [Hugo v0.91.2-extended](https://github.com/gohugoio/hugo/releases/tag/v0.91.2)

## Build

To build the site, run `hugo` in the root directory. You should have the built site in `public` directory.

## Live preview

Run `hugo serve` and it should spin up a local server with the site.

## Contributing

If you find a discrepancy with documentation, a typo or simply some new section to add or improve you can clone the docs and add contribute.

1. Clone repo `git clone https://github.com/alpacahq/alpaca-docs.git`

2. Make changes and preview with `hugo serve`. Hugo has autoreload capabilities so as you change you should see things get refreshed.