Code Monkey home page Code Monkey 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
$ ./onebox

Docs should be available at localhost:5555 once the onebox 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

shippablejedi avatar manishas avatar avinci avatar ambarish2012 avatar shrivara avatar himanshu0503 avatar ric03uec avatar jatindogra avatar deepikasl avatar a-murphy avatar niranjan92 avatar scriptnull avatar rageshkrishna avatar revathird avatar sreyaj avatar 0x-x0 avatar amalfra avatar riturajcse avatar harryi3t avatar rai-sushmitha avatar ankul-shippable avatar stephanielingwood avatar bharath92 avatar kanthchandra avatar haifeng-jin avatar hunt3ri avatar mikhail-tokarev avatar shubhankit92 avatar vishnurao12 avatar chaitanyavootla avatar

Watchers

James Cloos avatar 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.