Skip to content

Commit

Permalink
Added GitHub CI action (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
viktor-podzigun authored Feb 20, 2022
1 parent 9a861cc commit aeea8da
Show file tree
Hide file tree
Showing 22 changed files with 430 additions and 23 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# resources:
# https://remarkablemark.org/blog/2021/02/20/migrate-travis-ci-to-github-actions-ruby-workflow/
name: CI

on:
push:
branches: [ main ]
tags:
- '*'
pull_request:
branches: [ main ]

jobs:
build:
runs-on: ubuntu-latest
steps:

- name: Git checkout
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.4
bundler-cache: true # runs `bundle install` and caches installed gems automatically

- name: Run build
run: ./script/cibuild.sh
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
_site
.sass-cache
.jekyll-metadata
.idea
.DS_Store

Gemfile.lock
24 changes: 24 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
10 changes: 10 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
source "https://rubygems.org"

gem "jekyll-theme-slate"
#gem "jekyll-github-metadata"
gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
#group :jekyll_plugins do
# gem "jekyll-feed", "~> 0.6"
#end
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2022 FAR.js contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

[![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)

## FAR.js GitHub Pages

### Jekyll Theme

The site is built using the [jekyll-theme-slate](https://github.com/pages-themes/slate) theme.

### Previewing the site locally

If you'd like to preview the site locally (for example, in the process of proposing a change):

1. Clone down the site's repository (`git clone https://github.com/farjs/farjs.github.io`)
2. `cd` into the site's directory
3. Run `./script/bootstrap.sh` to install the necessary dependencies
4. Run `./script/server.sh` to start the preview server
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the site

### Running tests

The site contains a minimal test suite, to ensure a site with the theme would build successfully.
To run the tests, simply run `./script/cibuild.sh`.
You'll need to run `./script/bootstrap.sh` one before the test script will work.

### Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

```markdown
Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)
```

For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).

### How to embed draw.io Diagrams

[GitHub support](https://github.com/jgraph/drawio-github) is now available https://www.draw.io/?mode=github

An example for integration into GitHub wikis is available here [Embed Diagrams](https://github.com/jgraph/drawio/wiki/Embed-Diagrams)

Example diagrams are available [here](https://github.com/jgraph/drawio-diagrams)
50 changes: 49 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,49 @@
theme: jekyll-theme-slate
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: FAR.js
#email: [email protected]

description: >- # this means to ignore newlines
Cross-platform File and ARchive Manager in your terminal
show_downloads: false
#baseurl: "" # the subpath of your site, e.g. /blog
#url: "" # the base hostname & protocol for your site, e.g. http://example.com
#twitter_username: jekyllrb
#github_username: jekyll
#repository: farjs/farjs

is_project_page: true
repository_url: "https://github.com/farjs"

# Build settings
#markdown: kramdown
theme: jekyll-theme-slate
#plugins:
# - jekyll-feed
# - jekyll-github-metadata

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
# - Gemfile
# - Gemfile.lock
# - node_modules
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
13 changes: 13 additions & 0 deletions _includes/head-custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->

<!-- Setup Google Analytics -->
<!-- {% include head-custom-google-analytics.html %} -->

<!-- You can set your favicon here -->
<link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
<link rel="manifest" href="/site.webmanifest">

<!-- end custom head snippets -->
57 changes: 57 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">

<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,maximum-scale=2">
<link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">

{% seo %}
{% include head-custom.html %}
</head>

<body>

<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
{% if site.github.is_project_page %}
<a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
{% endif %}

<div class="header">
<a href="/">
<img src="/images/farjs_128_js.png" alt="logo" />
</a>
<h1 id="project_title">{{ site.title | default: site.github.repository_name }}</h1>
<h2 id="project_tagline">{{ site.description | default: site.github.project_tagline }}</h2>
</div>

{% if site.show_downloads %}
<section id="downloads">
<a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
<a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
</section>
{% endif %}
</header>
</div>

<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
{{ content }}
</section>
</div>

<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
{% if site.github.is_project_page %}
<p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
{% endif %}
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>
Binary file added android-chrome-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added android-chrome-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions assets/css/style.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
---

@import "{{ site.theme }}";

.header img {
float: left;
width: 100px;
height: 100px;
// background: #555;
}

.header h1 {
position: relative;
// top: 5px;
left: 20px;
}

.header h2 {
position: relative;
// top: 0px;
left: 20px;
}
Binary file added favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added favicon.ico
Binary file not shown.
Binary file added images/farjs_128_js.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit aeea8da

Please sign in to comment.