https://github.com/xtermjs/xtermjs.org
The website for xterm.js
https://github.com/xtermjs/xtermjs.org
Last synced: 8 months ago
JSON representation
The website for xterm.js
- Host: GitHub
- URL: https://github.com/xtermjs/xtermjs.org
- Owner: xtermjs
- License: mit
- Created: 2016-07-18T11:30:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-03T22:53:26.000Z (10 months ago)
- Last Synced: 2025-03-31T23:51:28.313Z (9 months ago)
- Language: JavaScript
- Homepage: https://xtermjs.org
- Size: 9.43 MB
- Stars: 31
- Watchers: 7
- Forks: 34
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repository hosts the code for http://xtermjs.org.
## Running via Codespaces
This project has a custom dev container to enable seamless development from a [Codespace](https://github.com/features/codespaces).
1. Create a Codespace
2. When the `postCreateCommand` finishes in the terminal run the default build task (ctrl+shift+b) or run `bundle exec jekyll serve` manually to run the website.
## Running locally
### Prerequisites
Linux dependencies:
```
sudo apt install zlib1g-dev
```
You also need [ruby](https://www.ruby-lang.org) and [bundler](https://bundler.io) installed.
### Installing dependencies and running
```bash
# Install dependencies
bundle install
# Serve the website
bundle exec jekyll serve
```
## Update API documentation
```bash
npm ci
./bin/update-docs
```