Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mertkahyaoglu committed Sep 24, 2017
1 parent c16185f commit a747f41
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ description: Jekyll Admin exists in two parts, a Ruby back end and a Javascript

Jekyll Admin piggybacks on Jekyll's built-in Webrick server. We monkey patch the `jekyll serve` command to hook in two Sinatra servers, one to serve the static front end that lives in `lib/jekyll-admin/public/dist` via `/admin`, and one to serve the Ruby API via `/_api`. Once the Sinatra servers are mounted, they work just like any other Jekyll server (and we rely on third-party plugins like `sintra-json` and `sinatra-cross_origin`).

**Note:** Since there are two Sinatra servers that might call `site.process` concurrently, Jekyll Admin disables `--watch` flag to prevent a race condition between these servers that might cause incorrect responses for the API. This ensures that the site is regenerated by only the process that Jekyll Admin runs.

## How Jekyll Admin formats Jekyll objects for the API

Whenever possible, we want to stay as close to the `to_liquid.to_json` representation of Jekyll's internal object structure as possible, so that we're (A) using data structure that developers are used to, and (B) so that we can benefit from upstream improvements. To do this, we have the `JekyllAdmin::APIable` module, which gets included in native Jekyll objects like Pages and Documents to add a `to_api` method which we can call to generate hashes for use in the API.

0 comments on commit a747f41

Please sign in to comment.