1
0
mirror of https://github.com/bitwarden/docs synced 2025-12-24 04:03:14 +00:00
Files
docs/README.md
Kyle Spearrin 170ea6c94e readme
2019-03-26 10:25:00 -04:00

25 lines
826 B
Markdown

[![appveyor build](https://ci.appveyor.com/api/projects/status/xmmrewrefxkq4xu7?svg=true)](https://ci.appveyor.com/project/bitwarden/docs)
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
# Bitwarden Docs Site
The Bitwarden docs site project is written using Jekyll, which is hosted/deployed to a GitHub pages branch ([https://docs.bitwarden.com/](https://docs.bitwarden.com/)).
# Build/Run
**Requirements**
- Node.js
- [Ruby](https://www.ruby-lang.org/)
- [Jekyll](https://jekyllrb.com/)
Run the following commands:
- `npm install`
- `npm run build:watch`
You can now access the help center at `http://localhost:4011`.
# Contribute
Article contributions are welcome! Please commit any pull requests against the `master` branch.