Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use semver.org as a basis for conventionalcommits.org #2

Merged
merged 15 commits into from
Apr 8, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_site
.DS_Store
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
conventionalcommits.org
41 changes: 41 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
source 'https://rubygems.org'

gem "jekyll", "3.4.3"
gem "jekyll-sass-converter", "1.5.0"

# Converters
gem "kramdown", "1.13.2"

# Misc
gem "liquid", "3.0.6"
gem "rouge", "1.11.1"

# Plugins
gem "jekyll-redirect-from", "0.12.1"
gem "jekyll-sitemap", "1.0.0"
gem "jekyll-feed", "0.9.2"
gem "jekyll-gist", "1.4.0"
gem "jekyll-paginate", "1.1.0"
gem "jekyll-coffeescript", "1.0.1"
gem "jekyll-seo-tag", "2.1.0"
gem "jekyll-avatar", "0.4.2"

# Plugins to match GitHub.com Markdown
gem "jemoji", "0.8.0"
gem "jekyll-mentions", "1.2.0"
gem "jekyll-relative-links", "0.4.0"
gem "jekyll-optional-front-matter", "0.1.2"
gem "jekyll-readme-index", "0.1.0"
gem "jekyll-default-layout", "0.1.4"
gem "jekyll-titles-from-headings", "0.1.5"

# Pin listen because it's broken on 2.1 & that's what we recommend.
# https://github.com/guard/listen/pull/371
gem "listen", "3.0.6"

# Pin activesupport because 5.0 is broken on 2.1
gem "activesupport", "4.2.7"
gem "html-proofer"
gem "rack-jekyll"
gem 'rake'
gem 'puma'
161 changes: 161 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.7)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
colorator (1.1.0)
colored (1.2)
ethon (0.10.1)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.12.0.1)
multipart-post (>= 1.2, < 3)
ffi (1.9.18)
forwardable-extended (2.6.0)
gemoji (3.0.0)
html-pipeline (2.5.0)
activesupport (>= 2)
nokogiri (>= 1.4)
html-proofer (3.6.0)
activesupport (>= 4.2, < 6.0)
addressable (~> 2.3)
colored (~> 1.2)
mercenary (~> 0.3.2)
nokogiri (~> 1.5)
parallel (~> 1.3)
typhoeus (~> 0.7)
yell (~> 2.0)
i18n (0.8.1)
jekyll (3.4.3)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-avatar (0.4.2)
jekyll (~> 3.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.9.2)
jekyll (~> 3.3)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-optional-front-matter (0.1.2)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.1.0)
jekyll (~> 3.0)
jekyll-redirect-from (0.12.1)
jekyll (~> 3.3)
jekyll-relative-links (0.4.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-seo-tag (2.1.0)
jekyll (~> 3.3)
jekyll-sitemap (1.0.0)
jekyll (~> 3.3)
jekyll-titles-from-headings (0.1.5)
jekyll (~> 3.3)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.8.0)
activesupport (~> 4.0)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.6)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minitest (5.10.1)
multipart-post (2.0.0)
nokogiri (1.7.1)
mini_portile2 (~> 2.1.0)
octokit (4.6.2)
sawyer (~> 0.8.0, >= 0.5.3)
parallel (1.11.1)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
puma (3.8.2)
rack (1.6.5)
rack-jekyll (0.5.0)
jekyll (>= 1.3)
listen (>= 1.3)
rack (~> 1.5)
rake (12.0.0)
rb-fsevent (0.9.8)
rb-inotify (0.9.8)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.23)
sawyer (0.8.1)
addressable (>= 2.3.5, < 2.6)
faraday (~> 0.8, < 1.0)
thread_safe (0.3.6)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.3)
thread_safe (~> 0.1)
yell (2.0.7)

PLATFORMS
ruby

DEPENDENCIES
activesupport (= 4.2.7)
html-proofer
jekyll (= 3.4.3)
jekyll-avatar (= 0.4.2)
jekyll-coffeescript (= 1.0.1)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.9.2)
jekyll-gist (= 1.4.0)
jekyll-mentions (= 1.2.0)
jekyll-optional-front-matter (= 0.1.2)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.1.0)
jekyll-redirect-from (= 0.12.1)
jekyll-relative-links (= 0.4.0)
jekyll-sass-converter (= 1.5.0)
jekyll-seo-tag (= 2.1.0)
jekyll-sitemap (= 1.0.0)
jekyll-titles-from-headings (= 0.1.5)
jemoji (= 0.8.0)
kramdown (= 1.13.2)
liquid (= 3.0.6)
listen (= 3.0.6)
puma
rack-jekyll
rake
rouge (= 1.11.1)

BUNDLED WITH
1.14.6
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: bundle exec puma -t 8:32 -w 3 -p $PORT
41 changes: 36 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
# conventional-changelog.github.io
Website of conventional-changelog
# ConventionalCommits.org

## Ideas
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

1. Demo of what conventional-changelog can do. The source itself can show how conventional-changelog works on the client side.
2. See https://github.com/conventional-changelog/meta/issues
This repo is the home of the Conventional Commits specification.

## Repo Layout

* `./index.md`: contains the current version of the specification.
* `./spec`: contains past versions of the specification.
* `./lang`: contains various translations of the specification.

## Contributing

We'd love your help refining the language of this specification,
fixing typos, or adding more translations. Please don't hesitate
to send a pull request.

### Adding a translation

1. Create a new folder in `lang/` with the appropriate language tag.
2. Add a translated `index.md` to that folder.
3. Add a translated `spec/vX.X.X.md` for the latest spec to that folder.
4. Ensure all files have the appropriate `title` and `language` front matter (see others as an example).
5. Add the language to the `_config.yml` file.

## Badges!

Tell your users that you use the Conventional Commits specification:

```markdown
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
```

## Thank you semver.org

We used [semver.org](https://github.com/mojombo/semver.org) as a blueprint for
both the website and structure of this specification.
5 changes: 5 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
namespace :assets do
task :precompile do
puts `bundle exec jekyll build`
end
end
30 changes: 30 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
title: Conventional Commits
descriptions: open-source maintainer, squash feature branches onto `master` and write a standardized commit message while doing so.

# Should be in the form of
# <machine readable key>: <human readable label>
languages:
en: english

versions:
- 1.0.0-beta

current_version: 1.0.0-beta

# Default author, for when none is set
author: Benjamin Coe

gems:
- jekyll-sitemap
- jekyll-seo-tag
- jekyll-redirect-from
- kramdown

defaults:
-
scope:
path: ""
values:
layout: "default"

exclude: ['config.ru', 'Gemfile', 'Gemfile.lock', 'vendor', 'Procfile', 'Rakefile']
2 changes: 2 additions & 0 deletions _config_local.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github:
url: ""
48 changes: 48 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!doctype html>
<html lang="{{ page.language | default: "en" }}" dir="{{ page.language_dir | default: "ltr" }}">
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="/css/main.css">
{% if page.custom_css %}
<link rel="stylesheet" href="/css/{{ page.language }}.css">
{% endif %}
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"/>
{% seo %}
</head>
<body>
<a href="https://github.com/conventional-changelog/conventionalcommits.org"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"></a>
<ol class="nav lang" dir="ltr">
{% assign sorted_languages = site.languages | sort %}
{% for language in sorted_languages %}
<li class="language language-{{ language[0] }}">
<a rel="alternate" lang="{{ language[0] }}" hreflang="{{ language[0] }}"
href="{{ language[0] | prepend: "/lang/" }}">
{{ language[1] | smartify }} ({{ language[0] }})
</a>
</li>
{% endfor %}
</ol>
<ol class="nav">
{% assign language = page.language | default: "en" %}
{% for version in site.versions %}
{% if language == "en" %}
{% assign expected = "spec/v" | append: version | append: ".md" %}
{% else %}
{% assign expected = "lang/" | append: language | append: "/spec/v" | append: version | append: ".md" %}
{% endif %}
{% assign found = site.pages | where: "path", expected | first %}
{% if found %}
<li class="version version-{{ version }}">
<a href="{{ found.url }}">
{{ version}}
</a>
</li>
{% endif %}
{% endfor %}
</ol>
<div id="spec">
{{ content }}
</div>
<script src="{{ site.github.url }}/js/anchorli.js"></script>
</body>
</html>
1 change: 1 addition & 0 deletions _site/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
conventionalcommits.org
28 changes: 28 additions & 0 deletions _site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# ConventionalCommits.org

This repo is the home of the Conventional Commits specification.

## Repo Layout

* `./index.md`: contains the current version of the specification.
* `./spec`: contains past versions of the specification.
* `./lang`: contains various translations of the specification.

## Contributing

We'd love your help refining the language of this specification,
fixing typos, or adding more translations. Please don't hesitate
to send a pull request.

### Adding a translation

1. Create a new folder in `lang/` with the appropriate language tag.
2. Add a translated `index.md` to that folder.
3. Add a translated `spec/vX.X.X.md` for the latest spec to that folder.
4. Ensure all files have the appropriate `title` and `language` front matter (see others as an example).
5. Add the language to the `_config.yml` file.

## Thank you semver.org

We used [semver.org](https://github.com/mojombo/semver.org) as a blueprint for
both the website and structure of this specification.
Loading