Skip to content

Commit 2226d00

Browse files
charoitelcharoitel
committed
Update docs
1 parent 2254603 commit 2226d00

File tree

7 files changed

+53
-26
lines changed

7 files changed

+53
-26
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.idea/
2+
docs/.jekyll-cache
13
docs/_site
24
docs/Gemfile.lock
35
nodejs/node_modules

‎docs/00-setup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Once you have your AWS account ready, there are two ways to deploy [lambda-layer
2828
6. Deployment is started and in progress
2929
7. Check your AWS Lambda console once the deployment is completed
3030

31-
## Deploy through AWS Lambda console
31+
## Deploy through AWS Lambda console
3232

3333
1. Login to your AWS account and open your AWS Lambda console
3434
2. Click **Create function** button

‎docs/Gemfile‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
source "https://rubygems.org"
2-
3-
gem "minima", "~> 2.5"
4-
gem "webrick", "~> 1.8"
5-
gem "github-pages", group: :jekyll_plugins
6-
7-
group :jekyll_plugins do
8-
gem "jekyll-feed", "~> 0.12"
9-
end
1+
gem "minima"

‎docs/_config.yml‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
title: Canvas Layer for AWS Lambda
22
description: >
3-
Cairo backed Mozilla Web Canvas API implementation layer for AWS Lambda.
4-
5-
author: Charoite Lee and contributors
6-
github_username: charoitel
7-
3+
Cairo backed Mozilla Web Canvas API implementation layer for AWS Lambda
84
theme: minima
9-
plugins:
10-
- jekyll-feed
11-
- jekyll-seo-tag
5+
show_feed_subscribe: false

‎docs/_includes/footer.html‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<footer class="site-footer h-card">
2+
<data class="u-url" href="{{ "/" | relative_url }}"></data>
3+
4+
<div class="wrapper">
5+
6+
<div class="footer-col-wrapper">
7+
<div class="footer-col">
8+
{%- if site.show_feed_subscribe -%}
9+
<p class="feed-subscribe">
10+
<a href="{{ site.feed.path | default: 'feed.xml' | absolute_url }}">
11+
<svg class="svg-icon orange">
12+
<use xlink:href="{{ 'assets/minima-social-icons.svg#rss' | relative_url }}"></use>
13+
</svg><span>Subscribe</span>
14+
</a>
15+
</p>
16+
{%- endif -%}
17+
{%- if site.author %}
18+
<ul class="contact-list">
19+
{% if site.author.name -%}
20+
<li class="p-name">{{ site.author.name | escape }}</li>
21+
{% endif -%}
22+
{% if site.author.email -%}
23+
<li><a class="u-email" href="mailto:{{ site.author.email }}">{{ site.author.email }}</a></li>
24+
{%- endif %}
25+
</ul>
26+
{%- endif %}
27+
</div>
28+
<div class="footer-col">
29+
<p>{{ site.description | escape }}</p>
30+
</div>
31+
</div>
32+
33+
<div class="social-links">
34+
{%- include social.html -%}
35+
</div>
36+
37+
</div>
38+
39+
</footer>

docs/favicon.ico renamed to docs/assets/favicon.ico

File renamed without changes.

‎docs/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
# Feel free to add content and custom Front Matter to this file.
3-
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
4-
52
layout: home
63
---
74

85
![GitHub](https://img.shields.io/github/license/charoitel/lambda-layer-canvas-nodejs)&nbsp;&nbsp;![Watch on GitHub](https://img.shields.io/github/watchers/charoitel/lambda-node-canvas.svg?style=social)&nbsp;&nbsp;![Fork on GitHub](https://img.shields.io/github/forks/charoitel/lambda-node-canvas.svg?style=social)&nbsp;&nbsp;![Star on GitHub](https://img.shields.io/github/stars/charoitel/lambda-node-canvas.svg?style=social)
96

10-
[lambda-layer-canvas-nodejs](https://github.com/charoitel/lambda-layer-canvas-nodejs) published on [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:990551184979:applications~lambda-layer-canvas-nodejs) packages node-canvas and its dependencies as AWS Lambda Layer.
7+
Canvas Layer for AWS Lambda is published and available on [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:990551184979:applications~lambda-layer-canvas-nodejs), and GitHub at [charoitel/lambda-layer-canvas-nodejs](https://github.com/charoitel/lambda-layer-canvas-nodejs). The layer aims to provide a Cairo backed Mozilla Web Canvas API implementation layer for AWS Lambda, powered by [node-canvas](https://github.com/Automattic/node-canvas).
118

129
## About node-canvas
1310

14-
[node-canvas](https://github.com/Automattic/node-canvas) is a Cairo backed Canvas implementation for Node.js. It implements the [Mozilla Web Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) as closely as possible. For the current API compliance, please check [Compatibility Status](https://github.com/Automattic/node-canvas/wiki/Compatibility-Status).
11+
[node-canvas](https://github.com/Automattic/node-canvas) is a Cairo backed Canvas implementation for Node.js. It implements the [Mozilla Web Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) as closely as possible. For the latest API compliance, you may check [Compatibility Status](https://github.com/Automattic/node-canvas/wiki/Compatibility-Status).
1512

1613
## How this layer is built?
1714

18-
The Lambda Layer is built from source of node-canvas npm package on EC2 instance, with following native dependencies installed. Please check ``` build-layer.sh ``` for details.
15+
The layer is built from source of node-canvas npm package on [amazonlinux](https://hub.docker.com/_/amazonlinux) dev container instance, with following native dependencies installed. You may check the build layer script, ``` build-layer.sh ```, which is available in repository, for details.
1916

20-
```console
17+
```bash
2118
gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel librsvg2-devel pango-devel bzip2-devel jq python3
2219
```
2320

24-
Since AWS Lambda is a secure and isolated runtime and execution environment, this layer aims to target AWS Lambda compatible build. As there are canvas libraries and frameworks relying on node-canvas running on Node.js runtime, this layer also tries to include and support these libraries and frameworks.
21+
Since AWS Lambda is a secure and isolated runtime and execution environment, the layer aims to target AWS Lambda compatible and native build. As there are canvas libraries and frameworks relying on node-canvas running on Node.js runtime, this layer may also try to include and support these libraries and frameworks. Currently there are two frameworks are included when building and packaging the layer:
22+
23+
- [Fabric.js](#fabricjs-support)
24+
- [Konva](#konva-support)
2525

2626
### Fabric.js support
2727

0 commit comments

Comments
 (0)