Skip to content

viktorvoltaire/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation site for Datadog

Built with nanoc, a static website generation tool.

Pre-requisites

  • Ruby
  • RubyGems
  • Bundler

Getting started

Install the dependencies with bundler. I like to install them under the project root:

$ bundle install --path vendor/bundle

Once the deps are installed, you should be able to accomplish what you need to with the included Rake tasks.

Doing stuff

Compile the static site:

$ bundle exec rake compile

Run a local webserver to view the compiled site:

$ bundle exec rake view

Run a local webserver and auto-update:

$ bundle exec rake autocompile

Toggle Syntax Highlighting

Syntax highlighting is really slow, so to turn it off while developing, run:

$ rake disable_syntax

To turn it back on:

$ rake enable_syntax

About

The source for Datadog's documentation site.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 32.6%
  • HTML 30.2%
  • SCSS 17.1%
  • Python 14.8%
  • Ruby 3.0%
  • Makefile 1.3%
  • Shell 1.0%