https://github.com/purescript-contrib/purescript-ace
Purescript bindings for the Ace editor
https://github.com/purescript-contrib/purescript-ace
Last synced: 3 months ago
JSON representation
Purescript bindings for the Ace editor
- Host: GitHub
- URL: https://github.com/purescript-contrib/purescript-ace
- Owner: purescript-contrib
- License: mit
- Created: 2015-01-16T17:00:44.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T13:52:09.000Z (about 3 years ago)
- Last Synced: 2025-02-10T20:14:35.307Z (about 1 year ago)
- Language: PureScript
- Homepage:
- Size: 281 KB
- Stars: 19
- Watchers: 14
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ace
[](https://github.com/purescript-contrib/purescript-ace/actions?query=workflow%3ACI+branch%3Amain)
[](https://github.com/purescript-contrib/purescript-ace/releases)
[](http://pursuit.purescript.org/packages/purescript-ace)
[](http://github.com/garyb)
PureScript bindings for the [Ace code editor](http://ace.c9.io).
## Installation
Install `ace` with [Spago](https://github.com/purescript/spago):
```sh
spago install ace
```
You may either include a CDN link in your project's `index.html`, or install the `ace-builds` npm dependency and let a bundler package it in your app. See Ace's [embedding guide](https://ace.c9.io/#nav=embedding) for more information.
### Here's a CDN example:
```html
Ace Demo
```
### To install via NPM instead:
```
npm install ace-builds
```
Note that you'll probably need the `src-noconflict` path when bundling with Common JS modules (PureScript's current output, until we switch to ES Modules in ~`0.15.0`). For example:
```html
```
## Quick start
The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the [docs directory](./docs).
## Documentation
`ace` documentation is stored in a few places:
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-ace).
2. Written documentation is kept in [the docs directory](./docs).
3. The [examples directory](./examples) demonstrates how to embed the Ace editor and configure it via the PureScript API.
If you get stuck, there are several ways to get help:
- [Open an issue](https://github.com/purescript-contrib/purescript-ace/issues) if you have encountered a bug or problem.
- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.
## Contributing
You can contribute to `ace` in several ways:
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-ace/issues). We'll do our best to work with you to resolve or answer it.
2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.