Skip to content

Adikteev/braze-docs

 
 

Repository files navigation

Welcome to Braze Docs!

This repository contains the source files for Braze Docs, which hosts all user, developer, partner, and API documentation for the Braze customer engagement platform.

If you'd like to help improve the docs, you can:

Quick start

Note: For a full walkthrough, see Contributing to Braze Docs.

To build the docs locally, you'll need Ruby version 3.2.2 installed. In the terminal, open braze-docs and check for Ruby version 3.2.2.

cd ~/braze-docs
ruby --version

If 3.2.2 is not installed, use a supported version manager to install it. For example, using rbenv:

rbenv install 3.2.2

Next, install project dependencies.

bundle install

To start your local docs server on localhost http://127.0.0.1:4000, run:

rake

To stop your server, reopen the terminal and press Control+C.

Creative Commons license

Braze Docs is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. For more information, see LICENSE.

Licence Icon

Code of conduct

At Braze, we expect respectful behavior from both administrators and contributors. For more information, see CODE_OF_CONDUCT.md.

Contributor Covenant

Releases

No releases published

Packages

No packages published

Languages

  • HTML 38.2%
  • SCSS 33.7%
  • JavaScript 13.8%
  • Ruby 13.4%
  • Rich Text Format 0.6%
  • Shell 0.3%