Skip to content

Commit aeea8da

Browse files
viktor-podzigunviktor-podzigun
authored
Added GitHub CI action (#1)
1 parent 9a861cc commit aeea8da

22 files changed

+430
-23
lines changed

‎.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# resources:
2+
# https://remarkablemark.org/blog/2021/02/20/migrate-travis-ci-to-github-actions-ruby-workflow/
3+
name: CI
4+
5+
on:
6+
push:
7+
branches: [ main ]
8+
tags:
9+
- '*'
10+
pull_request:
11+
branches: [ main ]
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
steps:
17+
18+
- name: Git checkout
19+
uses: actions/checkout@v2
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Setup Ruby
24+
uses: ruby/setup-ruby@v1
25+
with:
26+
ruby-version: 2.4
27+
bundler-cache: true # runs `bundle install` and caches installed gems automatically
28+
29+
- name: Run build
30+
run: ./script/cibuild.sh

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
_site
2+
.sass-cache
3+
.jekyll-metadata
4+
.idea
5+
.DS_Store
6+
7+
Gemfile.lock

‎404.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: default
3+
---
4+
5+
<style type="text/css" media="screen">
6+
.container {
7+
margin: 10px auto;
8+
max-width: 600px;
9+
text-align: center;
10+
}
11+
h1 {
12+
margin: 30px 0;
13+
font-size: 4em;
14+
line-height: 1;
15+
letter-spacing: -1px;
16+
}
17+
</style>
18+
19+
<div class="container">
20+
<h1>404</h1>
21+
22+
<p><strong>Page not found :(</strong></p>
23+
<p>The requested page could not be found.</p>
24+
</div>

‎Gemfile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll-theme-slate"
4+
#gem "jekyll-github-metadata"
5+
gem "github-pages", group: :jekyll_plugins
6+
7+
# If you have any plugins, put them here!
8+
#group :jekyll_plugins do
9+
# gem "jekyll-feed", "~> 0.6"
10+
#end

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022 FAR.js contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
[![CI](https://github.com/farjs/farjs.github.io/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/farjs/farjs.github.io/actions/workflows/ci.yml?query=workflow%3Aci+branch%3Amain)
3+
4+
## FAR.js GitHub Pages
5+
6+
### Jekyll Theme
7+
8+
The site is built using the [jekyll-theme-slate](https://github.com/pages-themes/slate) theme.
9+
10+
### Previewing the site locally
11+
12+
If you'd like to preview the site locally (for example, in the process of proposing a change):
13+
14+
1. Clone down the site's repository (`git clone https://github.com/farjs/farjs.github.io`)
15+
2. `cd` into the site's directory
16+
3. Run `./script/bootstrap.sh` to install the necessary dependencies
17+
4. Run `./script/server.sh` to start the preview server
18+
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the site
19+
20+
### Running tests
21+
22+
The site contains a minimal test suite, to ensure a site with the theme would build successfully.
23+
To run the tests, simply run `./script/cibuild.sh`.
24+
You'll need to run `./script/bootstrap.sh` one before the test script will work.
25+
26+
### Markdown
27+
28+
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
29+
30+
```markdown
31+
Syntax highlighted code block
32+
33+
# Header 1
34+
## Header 2
35+
### Header 3
36+
37+
- Bulleted
38+
- List
39+
40+
1. Numbered
41+
2. List
42+
43+
**Bold** and _Italic_ and `Code` text
44+
45+
[Link](url) and ![Image](src)
46+
```
47+
48+
For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
49+
50+
### How to embed draw.io Diagrams
51+
52+
[GitHub support](https://github.com/jgraph/drawio-github) is now available https://www.draw.io/?mode=github
53+
54+
An example for integration into GitHub wikis is available here [Embed Diagrams](https://github.com/jgraph/drawio/wiki/Embed-Diagrams)
55+
56+
Example diagrams are available [here](https://github.com/jgraph/drawio-diagrams)

‎_config.yml

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
theme: jekyll-theme-slate
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole blog, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10+
11+
# Site settings
12+
# These are used to personalize your new site. If you look in the HTML files,
13+
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
14+
# You can create any custom variable you would like, and they will be accessible
15+
# in the templates via {{ site.myvariable }}.
16+
title: FAR.js
17+
#email: [email protected]
18+
19+
description: >- # this means to ignore newlines
20+
Cross-platform File and ARchive Manager in your terminal
21+
22+
show_downloads: false
23+
#baseurl: "" # the subpath of your site, e.g. /blog
24+
#url: "" # the base hostname & protocol for your site, e.g. http://example.com
25+
#twitter_username: jekyllrb
26+
#github_username: jekyll
27+
#repository: farjs/farjs
28+
29+
is_project_page: true
30+
repository_url: "https://github.com/farjs"
31+
32+
# Build settings
33+
#markdown: kramdown
34+
theme: jekyll-theme-slate
35+
#plugins:
36+
# - jekyll-feed
37+
# - jekyll-github-metadata
38+
39+
# Exclude from processing.
40+
# The following items will not be processed, by default. Create a custom list
41+
# to override the default setting.
42+
# exclude:
43+
# - Gemfile
44+
# - Gemfile.lock
45+
# - node_modules
46+
# - vendor/bundle/
47+
# - vendor/cache/
48+
# - vendor/gems/
49+
# - vendor/ruby/

‎_includes/head-custom.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
2+
3+
<!-- Setup Google Analytics -->
4+
<!-- {% include head-custom-google-analytics.html %} -->
5+
6+
<!-- You can set your favicon here -->
7+
<link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}">
8+
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
9+
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
10+
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
11+
<link rel="manifest" href="/site.webmanifest">
12+
13+
<!-- end custom head snippets -->

‎_layouts/default.html

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!DOCTYPE html>
2+
<html lang="{{ site.lang | default: "en-US" }}">
3+
4+
<head>
5+
<meta charset='utf-8'>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
7+
<meta name="viewport" content="width=device-width,maximum-scale=2">
8+
<link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
9+
10+
{% seo %}
11+
{% include head-custom.html %}
12+
</head>
13+
14+
<body>
15+
16+
<!-- HEADER -->
17+
<div id="header_wrap" class="outer">
18+
<header class="inner">
19+
{% if site.github.is_project_page %}
20+
<a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
21+
{% endif %}
22+
23+
<div class="header">
24+
<a href="/">
25+
<img src="/images/farjs_128_js.png" alt="logo" />
26+
</a>
27+
<h1 id="project_title">{{ site.title | default: site.github.repository_name }}</h1>
28+
<h2 id="project_tagline">{{ site.description | default: site.github.project_tagline }}</h2>
29+
</div>
30+
31+
{% if site.show_downloads %}
32+
<section id="downloads">
33+
<a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
34+
<a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
35+
</section>
36+
{% endif %}
37+
</header>
38+
</div>
39+
40+
<!-- MAIN CONTENT -->
41+
<div id="main_content_wrap" class="outer">
42+
<section id="main_content" class="inner">
43+
{{ content }}
44+
</section>
45+
</div>
46+
47+
<!-- FOOTER -->
48+
<div id="footer_wrap" class="outer">
49+
<footer class="inner">
50+
{% if site.github.is_project_page %}
51+
<p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
52+
{% endif %}
53+
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
54+
</footer>
55+
</div>
56+
</body>
57+
</html>

‎android-chrome-192x192.png

11.7 KB
Loading

0 commit comments

Comments
 (0)