Skip to content
API docs frontend for TurtleCoin
Branch: turtle-master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
scripts
source
.editorconfig Add editorconfig (#891) Oct 30, 2017
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb
font-selection.json

README.md

image

Build Status

Developing

Setup

  1. Make sure you have Ruby 2.3 or newer installed.
  2. Run gem install bundler to install bundler.
  3. Run bundle install to install the dependencies of this project.
  4. Create a symlink called turtlecoin-docs to the turtlecoin-docs project. For example run ln -s ../turtlecoin-docs turtlecoin-docs to create a link to the turtlecoin-docs folder located at the same level as the folder containing this project.
  5. Run bundle exec middleman server to start the development server at http://localhost:4567.

Development notes

  • Changes should target the turtle-master branch, instead of master.
  • Site specific styles are in source/stylesheets/turtlecoin.
  • Pulls content from the turtlecoin-docs/docs/api folder.

About Slate

This project is based on Slate. Slate, in turn uses Middleman for static site generation. Slate projects are forks of the Slate repo. All TurtleCoin specific changes should be made on the turtle-master branch, instead of master. This makes it cleaner and easier to fetch updates from Slate's master branch.

Deployment

A commit to turtlecoin-docs/master auto builds this project via Travis CI, which deploys the latest content from there.

Contributors

You can’t perform that action at this time.