# rxjs-docs

**Repository Path**: mirrors_ReactiveX/rxjs-docs

## Basic Information

- **Project Name**: rxjs-docs
- **Description**: The home for new work on the new RxJS docs (RxJS v 5 and up). New to this space? Say hi here: https://github.com/ReactiveX/rxjs-docs/issues/24. Want to find out what's up? We're chatting here. https://github.com/ReactiveX/rxjs-docs/issues/4
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/ReactiveX/rxjs-docs.svg?branch=master)](https://travis-ci.org/ReactiveX/rxjs-docs)

# THIS REPOSITORY IS DEPRECATED. THE RXJS DOCS ARE DEVELOPED AT THE [RXJS REPO](https://github.com/ReactiveX/rxjs) 

# [rxjs-docs](http://rxjsdocs.com/)
The home for new work on the new RxJS docs (RxJS v5 and up).
Website (currently beta) can be found [here](http://rxjsdocs.com/). 
We highly welcome any kind of feedback or contribution.

License is the same as the RxJS project: https://github.com/reactivex/rxjs

[Apache 2.0 License](LICENSE.txt)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Contribution Guidelines](CONTRIBUTING.md)

## Important

By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity.

## Goals

- Serve updated docs for RxJs
- Serve multiple translations for the docs
- Provide working examples

## Contributing

More detailed information can be found in the [Contribution Guidelines](CONTRIBUTING.md)

## Building/Testing

The build and test structure is fairly primitive at the moment. There are various npm scripts that can be run:

- start: runs the dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
- test: runs tests with `jasmine`, must have built prior to running.
- build: build artifacts will be stored in the `dist/` directory
- build-prod: builds for production using the `--prod` flag
- commit: runs git commit wizard for passing rxjs-github-bot message validator

## Committing
It is strongly recommended that when creating a commit, you follow this procedure to start the commit wizard. It will aid you on creating valid commit messages.

```shell
git add .
npm run commit
```