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:

• Report an issue
• Request a feature
• Contribute

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

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

cd ~/braze-docs
ruby --version

If this version isn't installed, use a supported version manager to install it. For example, using rbenv:

rbenv install 3.3.0

Next, install project dependencies.

bundle install

To start your local docs server on localhost http://127.0.0.1:4000, run the following command. To stop your server, reopen the terminal and press Control+C.

# for 'en' language:
rake

# for other langauges:
rake es
rake fr
rake ja
rake ko
rake pt_br

# to render content in '{% markdown_embed %}' tags:
MARKDOWN_API=true rake

# to render tiles on partner landing pages:
PARTNER_API=true rake

# to render both APIs:
MARKDOWN_API=true PARTNER_API=true rake

Note: Prepending MARKDOWN_API=true to your rake command let's you preview content within a {% markdown_embed %} tag, such as the content on the Developer Guide: Changelogs page. Prepending PARTNER_API=true let's you render the tiles on a partner landing page, such as Technology Partners.

bdocs is a wrapper script located in the root of this repository that helps you replace links, generate redirect URLs, create deployment descriptions, and more. For an in-depth walkthrough, see bdocs wrapper. To get started quickly, run the following command to see a list of available commands:

./bdocs

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

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