The AppSignal documentation website!
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

AppSignal Documentation

This repository contains the source for the AppSignal documentation website.


Run the following commands:

git submodule init
git submodule update


bundle install
bundle exec middleman

Open the browser at localhost:4567 and click around.


bundle exec rake build_deploy


Markdown customizations

To render notices we've added a custom markdown tag. Use it like so:

!> This is a warning!
-> This is a notice!

# I'm a heading
#^prefix I'm a heading
#=anchor-override I'm a heading

Which will render the following:

<div class="warning">
  <p>This is a warning!</p>
<div class="notice">
  <p>This is a notice!</p>

<h1><span class="anchor" id="im-a-heading"></span><a href="#im-a-heading">I'm a heading</a></h1>
<h1><span class="anchor" id="prefix-im-a-heading"></span><a href="#prefix-im-a-heading">I'm a heading</a></h1>
<h1><span class="anchor" id="anchor-override"></span><a href="#anchor-override">I'm a heading</a></h1>

For more information (and code) about these customizations, please see the appsignal_markdown.rb file.


Thinking of contributing to our documentation? Awesome! 🚀

Please follow our Contributing guide in our documentation.

Also, we would be very happy to send you Stroopwaffles. Have look at everyone we send a package to so far on our Stroopwaffles page.