mirror of
https://github.com/bitwarden/docs
synced 2025-12-06 01:33:19 +00:00
readme
This commit is contained in:
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
[](https://ci.appveyor.com/project/bitwarden/docs)
|
||||
[](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.
|
||||
Reference in New Issue
Block a user