Skip to content

phoet/appsignal-docs

master
Switch branches/tags
Code
This branch is 205 commits behind appsignal:master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

AppSignal Documentation

This repository contains the source for the AppSignal documentation website.

Setup

Run the following commands:

git submodule init
git submodule update

Usage

bundle install
bundle exec middleman

Open the browser at localhost:4567 and click around.

Deployment

bundle exec rake build_deploy

Content

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>
<div class="notice">
  <p>This is a notice!</p>
</div>

<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.

Contributing

Thinking of contributing to our documentation? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

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.

About

The AppSignal documentation website!

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 45.6%
  • HTML 33.7%
  • Ruby 12.2%
  • JavaScript 8.5%