Skip to content

Commit 8a0fa10

Browse files
committed
added jekyll theme
1 parent 81bb32a commit 8a0fa10

27 files changed

+1975
-0
lines changed

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at https://github.com/contact/report-abuse. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Contributing
2+
3+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
4+
5+
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
6+
7+
## Submitting a pull request
8+
9+
0. [Fork][fork] and clone the repository
10+
0. Configure and install the dependencies: `script/bootstrap`
11+
0. Make sure the tests pass on your machine: `script/cibuild`
12+
0. Create a new branch: `git checkout -b my-branch-name`
13+
0. Make your change, add tests, and make sure the tests still pass
14+
0. Push to your fork and [submit a pull request][pr]
15+
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
16+
17+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
18+
19+
- Follow the [style guide][style].
20+
- Write tests.
21+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
22+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
23+
24+
## Resources
25+
26+
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
27+
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
28+
- [GitHub Help](https://help.github.com)
29+
30+
[fork]: https://github.com/pages-themes/architect/fork
31+
[pr]: https://github.com/pages-themes/architect/compare
32+
[style]: http://ben.balter.com/jekyll-style-guide/
33+
[code-of-conduct]: CODE_OF_CONDUCT.md

Gemfile

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source 'https://rubygems.org'
2+
3+
gemspec

Gemfile.lock

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
PATH
2+
remote: .
3+
specs:
4+
jekyll-theme-architect (0.0.4)
5+
jekyll (~> 3.3)
6+
7+
GEM
8+
remote: https://rubygems.org/
9+
specs:
10+
addressable (2.5.1)
11+
public_suffix (~> 2.0, >= 2.0.2)
12+
colorator (1.1.0)
13+
ffi (1.9.18)
14+
forwardable-extended (2.6.0)
15+
jekyll (3.5.0)
16+
addressable (~> 2.4)
17+
colorator (~> 1.0)
18+
jekyll-sass-converter (~> 1.0)
19+
jekyll-watch (~> 1.1)
20+
kramdown (~> 1.3)
21+
liquid (~> 4.0)
22+
mercenary (~> 0.3.3)
23+
pathutil (~> 0.9)
24+
rouge (~> 1.7)
25+
safe_yaml (~> 1.0)
26+
jekyll-sass-converter (1.5.0)
27+
sass (~> 3.4)
28+
jekyll-watch (1.5.0)
29+
listen (~> 3.0, < 3.1)
30+
kramdown (1.14.0)
31+
liquid (4.0.0)
32+
listen (3.0.8)
33+
rb-fsevent (~> 0.9, >= 0.9.4)
34+
rb-inotify (~> 0.9, >= 0.9.7)
35+
mercenary (0.3.6)
36+
pathutil (0.14.0)
37+
forwardable-extended (~> 2.6)
38+
public_suffix (2.0.5)
39+
rb-fsevent (0.10.2)
40+
rb-inotify (0.9.10)
41+
ffi (>= 0.5.0, < 2)
42+
rouge (1.11.1)
43+
safe_yaml (1.0.4)
44+
sass (3.4.25)
45+
46+
PLATFORMS
47+
ruby
48+
49+
DEPENDENCIES
50+
jekyll-theme-architect!
51+
52+
BUNDLED WITH
53+
1.15.1

LICENSE

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
CC0 1.0 Universal
2+
3+
Statement of Purpose
4+
5+
The laws of most jurisdictions throughout the world automatically confer
6+
exclusive Copyright and Related Rights (defined below) upon the creator and
7+
subsequent owner(s) (each and all, an "owner") of an original work of
8+
authorship and/or a database (each, a "Work").
9+
10+
Certain owners wish to permanently relinquish those rights to a Work for the
11+
purpose of contributing to a commons of creative, cultural and scientific
12+
works ("Commons") that the public can reliably and without fear of later
13+
claims of infringement build upon, modify, incorporate in other works, reuse
14+
and redistribute as freely as possible in any form whatsoever and for any
15+
purposes, including without limitation commercial purposes. These owners may
16+
contribute to the Commons to promote the ideal of a free culture and the
17+
further production of creative, cultural and scientific works, or to gain
18+
reputation or greater distribution for their Work in part through the use and
19+
efforts of others.
20+
21+
For these and/or other purposes and motivations, and without any expectation
22+
of additional consideration or compensation, the person associating CC0 with a
23+
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
24+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
25+
and publicly distribute the Work under its terms, with knowledge of his or her
26+
Copyright and Related Rights in the Work and the meaning and intended legal
27+
effect of CC0 on those rights.
28+
29+
1. Copyright and Related Rights. A Work made available under CC0 may be
30+
protected by copyright and related or neighboring rights ("Copyright and
31+
Related Rights"). Copyright and Related Rights include, but are not limited
32+
to, the following:
33+
34+
i. the right to reproduce, adapt, distribute, perform, display, communicate,
35+
and translate a Work;
36+
37+
ii. moral rights retained by the original author(s) and/or performer(s);
38+
39+
iii. publicity and privacy rights pertaining to a person's image or likeness
40+
depicted in a Work;
41+
42+
iv. rights protecting against unfair competition in regards to a Work,
43+
subject to the limitations in paragraph 4(a), below;
44+
45+
v. rights protecting the extraction, dissemination, use and reuse of data in
46+
a Work;
47+
48+
vi. database rights (such as those arising under Directive 96/9/EC of the
49+
European Parliament and of the Council of 11 March 1996 on the legal
50+
protection of databases, and under any national implementation thereof,
51+
including any amended or successor version of such directive); and
52+
53+
vii. other similar, equivalent or corresponding rights throughout the world
54+
based on applicable law or treaty, and any national implementations thereof.
55+
56+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
57+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
58+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
59+
and Related Rights and associated claims and causes of action, whether now
60+
known or unknown (including existing as well as future claims and causes of
61+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
62+
duration provided by applicable law or treaty (including future time
63+
extensions), (iii) in any current or future medium and for any number of
64+
copies, and (iv) for any purpose whatsoever, including without limitation
65+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
66+
the Waiver for the benefit of each member of the public at large and to the
67+
detriment of Affirmer's heirs and successors, fully intending that such Waiver
68+
shall not be subject to revocation, rescission, cancellation, termination, or
69+
any other legal or equitable action to disrupt the quiet enjoyment of the Work
70+
by the public as contemplated by Affirmer's express Statement of Purpose.
71+
72+
3. Public License Fallback. Should any part of the Waiver for any reason be
73+
judged legally invalid or ineffective under applicable law, then the Waiver
74+
shall be preserved to the maximum extent permitted taking into account
75+
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
76+
is so judged Affirmer hereby grants to each affected person a royalty-free,
77+
non transferable, non sublicensable, non exclusive, irrevocable and
78+
unconditional license to exercise Affirmer's Copyright and Related Rights in
79+
the Work (i) in all territories worldwide, (ii) for the maximum duration
80+
provided by applicable law or treaty (including future time extensions), (iii)
81+
in any current or future medium and for any number of copies, and (iv) for any
82+
purpose whatsoever, including without limitation commercial, advertising or
83+
promotional purposes (the "License"). The License shall be deemed effective as
84+
of the date CC0 was applied by Affirmer to the Work. Should any part of the
85+
License for any reason be judged legally invalid or ineffective under
86+
applicable law, such partial invalidity or ineffectiveness shall not
87+
invalidate the remainder of the License, and in such case Affirmer hereby
88+
affirms that he or she will not (i) exercise any of his or her remaining
89+
Copyright and Related Rights in the Work or (ii) assert any associated claims
90+
and causes of action with respect to the Work, in either case contrary to
91+
Affirmer's express Statement of Purpose.
92+
93+
4. Limitations and Disclaimers.
94+
95+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
96+
surrendered, licensed or otherwise affected by this document.
97+
98+
b. Affirmer offers the Work as-is and makes no representations or warranties
99+
of any kind concerning the Work, express, implied, statutory or otherwise,
100+
including without limitation warranties of title, merchantability, fitness
101+
for a particular purpose, non infringement, or the absence of latent or
102+
other defects, accuracy, or the present or absence of errors, whether or not
103+
discoverable, all to the greatest extent permissible under applicable law.
104+
105+
c. Affirmer disclaims responsibility for clearing rights of other persons
106+
that may apply to the Work or any use thereof, including without limitation
107+
any person's Copyright and Related Rights in the Work. Further, Affirmer
108+
disclaims responsibility for obtaining any necessary consents, permissions
109+
or other rights required for any use of the Work.
110+
111+
d. Affirmer understands and acknowledges that Creative Commons is not a
112+
party to this document and has no duty or obligation with respect to this
113+
CC0 or use of the Work.
114+
115+
For more information, please see
116+
<http://creativecommons.org/publicdomain/zero/1.0/>

README.md

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# The Architect theme
2+
3+
[![Build Status](https://travis-ci.org/pages-themes/architect.svg?branch=master)](https://travis-ci.org/pages-themes/architect) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-architect.svg)](https://badge.fury.io/rb/jekyll-theme-architect)
4+
5+
*Architect is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/architect), or even [use it today](#usage).*
6+
7+
![Thumbnail of architect](thumbnail.png)
8+
9+
## Usage
10+
11+
To use the Architect theme:
12+
13+
1. Add the following to your site's `_config.yml`:
14+
15+
```yml
16+
theme: jekyll-theme-architect
17+
```
18+
19+
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
20+
21+
```ruby
22+
gem "github-pages", group: :jekyll_plugins
23+
```
24+
25+
26+
27+
## Customizing
28+
29+
### Configuration variables
30+
31+
Architect will respect the following variables, if set in your site's `_config.yml`:
32+
33+
```yml
34+
title: [The title of your site]
35+
description: [A short description of your site's purpose]
36+
```
37+
38+
Additionally, you may choose to set the following optional variables:
39+
40+
```yml
41+
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
42+
google_analytics: [Your Google Analytics tracking ID]
43+
```
44+
45+
### Stylesheet
46+
47+
If you'd like to add your own custom styles:
48+
49+
1. Create a file called `/assets/css/style.scss` in your site
50+
2. Add the following content to the top of the file, exactly as shown:
51+
```scss
52+
---
53+
---
54+
55+
@import "{{ site.theme }}";
56+
```
57+
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
58+
59+
### Layouts
60+
61+
If you'd like to change the theme's HTML layout:
62+
63+
1. [Copy the original template](https://github.com/pages-themes/architect/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
64+
2. Create a file called `/_layouts/default.html` in your site
65+
3. Paste the default layout content copied in the first step
66+
4. Customize the layout as you'd like
67+
68+
## Roadmap
69+
70+
See the [open issues](https://github.com/pages-themes/architect/issues) for a list of proposed features (and known issues).
71+
72+
## Project philosophy
73+
74+
The Architect theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
75+
76+
## Contributing
77+
78+
Interested in contributing to Architect? We'd love your help. Architect is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.
79+
80+
### Previewing the theme locally
81+
82+
If you'd like to preview the theme locally (for example, in the process of proposing a change):
83+
84+
1. Clone down the theme's repository (`git clone https://github.com/pages-themes/architect`)
85+
2. `cd` into the theme's directory
86+
3. Run `script/bootstrap` to install the necessary dependencies
87+
4. Run `bundle exec jekyll serve` to start the preview server
88+
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
89+
90+
### Running tests
91+
92+
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.

_config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
title: Architect theme
2+
description: Architect is a theme for GitHub Pages.
3+
show_downloads: true
4+
google_analytics:
5+
theme:

0 commit comments

Comments
 (0)