Giter Club home page Giter Club logo

semaphore-docs-new's Introduction

Semaphore Docs

Semaphore Docs, powered by Middleman and Amazon S3.

Setup

Clone the repo and install all necessary gems with

$ git clone [email protected]:renderedtext/semaphore-docs-new.git
$ bundle install --path .bundle

Writing

Pages are stored in source/docs/.

To view the blog locally run:

./server

which actually runs

$ bundle exec middleman -p 4000

Now you can open http://localhost:4000/docs.

Embedding images

There's a helper defined in config.rb which we use as follows.

First, rename the file from .md to .md.erb. Then instead of:

<img src="/blog/assets/images/2012-06-14/semaphore-homepage.png" width="700" />

we write:

<p><%= image_tag image_url("/blog/assets/images/2012-06-14/semaphore-homepage.png"), :width => 700 %></p>

Escaping Erb

You must escape Erb code snippets in files with `.erb` extension ([via](https://github.com/middleman/middleman-syntax/issues/29)):

<%%= foo %>

Deployment

To build a new version of the site locally:

$ bundle exec middleman build

Before deploying make sure that you have all configuration files with credentials, see configuration for more info. When you're ready, deploy the content to Amazon S3 with:

$ bundle exec middleman s3_sync

P.S. You must build the blog before deploying.

Configuration

All sensitive credentials are stored in data/credentials.yml check data/credentials.yml.example for more info about format of file.

semaphore-docs-new's People

Contributors

cmoel avatar darkofabijan avatar integra-credit avatar markoa avatar peashutop avatar rastasheep avatar shiroyasha avatar strika avatar tony-f 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.