Git Product home page Git Product logo

docs's Introduction

docs

Documentation for Shippable's Automated DevOps platform

Using Local Installation

With Docker

$ git clone [email protected]:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ ./base

Docs should be available at localhost:5555 once the base script finishes successfully.

Without Docker

To get started you have to have git and python3 with pip and virtualenv installed:

$ git clone [email protected]:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ virtualenv venv
$ source venv/bin/activate
(venv)$ pip install -r requirements.txt
Server

To start documentation server at localhost:5555:

(venv)$ mkdocs serve --dev-addr=localhost:5555

This uses livereload to monitors changes to the files. Therefore as soon as you save a file, the browser is refreshed.

docs's People

Contributors

0x-x0 avatar a-murphy avatar ambarish2012 avatar ankul-shippable avatar haifeng-jin avatar harryi3t avatar himanshu0503 avatar jatindogra avatar manishas avatar rageshkrishna avatar revathird avatar ric03uec avatar scriptnull avatar shippablejedi avatar shrivara avatar shubhankit92 avatar sreyaj avatar stephanielingwood avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.