diff --git a/.bowerrc b/.bowerrc
new file mode 100644
index 0000000..cc48978
--- /dev/null
+++ b/.bowerrc
@@ -0,0 +1,3 @@
+{
+ "directory": "assets/vendor"
+}
diff --git a/.gitignore b/.gitignore
index a0346a7..394ad62 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,12 @@
.DS_Store
/_site
/node_modules
+/.bundle
+assets/vendor/zeroclipboard/docs
+assets/vendor/zeroclipboard/src
+assets/vendor/zeroclipboard/test
+assets/vendor/selectivizr/tests
+assets/vendor/qtip2/basic
+/vendor
+Gemfile.lock
+/.sass-cache
diff --git a/.travis.yml b/.travis.yml
index 1b743c0..d15e661 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -14,3 +14,10 @@ branches:
notifications:
email: false
+
+env:
+ global:
+ - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+sudo: false
+cache: bundler
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 04435d9..a4434c9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,12 +24,12 @@ The easiest way to make a change is to simply edit a file from your browser.
When you click the edit button, it will fork the repository under your account.
Note what issue/issues your patch fixes in the commit message.
-For example, to [change this file](https://github.com/github/choosealicense.com/blob/master/CONTRIBUTING.md),
+For example, to [change this file](/CONTRIBUTING.md),
find it in the GitHub repository. Then click the `Edit` button. Make your
changes, type in a commit message, and click the `Propose File Change` button.
That’s it!
-For more advanced changes, check out [the bootstrap instructions](https://github.com/github/choosealicense.com#run-it-on-your-machine) in the [project's readme](https://github.com/github/choosealicense.com/blob/master/README.md).
+For more advanced changes, check out [the bootstrap instructions](https://github.com/github/choosealicense.com#run-it-on-your-machine) in the [project's readme](/README.md).
## Testing
diff --git a/Gemfile b/Gemfile
index b89849d..d94f79e 100644
--- a/Gemfile
+++ b/Gemfile
@@ -2,9 +2,9 @@ source "https://rubygems.org"
ruby File.read(".ruby-version").strip
gem "github-pages"
-gem "ffi", "1.9.0"
group :test do
gem "html-proofer"
gem "rake"
+ gem "rspec"
end
diff --git a/Gemfile.lock b/Gemfile.lock
deleted file mode 100644
index d0e4c0c..0000000
--- a/Gemfile.lock
+++ /dev/null
@@ -1,82 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- RedCloth (4.2.9)
- blankslate (2.1.2.4)
- classifier (1.3.3)
- fast-stemmer (>= 1.0.0)
- colorator (0.1)
- colored (1.2)
- commander (4.1.5)
- highline (~> 1.6.11)
- ethon (0.6.1)
- ffi (>= 1.3.0)
- mime-types (~> 1.18)
- fast-stemmer (1.0.2)
- ffi (1.9.0)
- github-pages (12)
- RedCloth (= 4.2.9)
- jekyll (= 1.4.2)
- kramdown (= 1.2.0)
- liquid (= 2.5.4)
- maruku (= 0.7.0)
- rdiscount (= 2.1.7)
- redcarpet (= 2.3.0)
- highline (1.6.20)
- html-proofer (0.3.0)
- colored (~> 1.2)
- mercenary (~> 0.2.0)
- nokogiri (~> 1.6.0)
- typhoeus (~> 0.6.3)
- jekyll (1.4.2)
- classifier (~> 1.3)
- colorator (~> 0.1)
- commander (~> 4.1.3)
- liquid (~> 2.5.2)
- listen (~> 1.3)
- maruku (~> 0.7.0)
- pygments.rb (~> 0.5.0)
- redcarpet (~> 2.3.0)
- safe_yaml (~> 0.9.7)
- toml (~> 0.1.0)
- kramdown (1.2.0)
- liquid (2.5.4)
- listen (1.3.1)
- rb-fsevent (>= 0.9.3)
- rb-inotify (>= 0.9)
- rb-kqueue (>= 0.2)
- maruku (0.7.0)
- mercenary (0.2.0)
- mime-types (1.25.1)
- mini_portile (0.5.2)
- nokogiri (1.6.1)
- mini_portile (~> 0.5.0)
- parslet (1.5.0)
- blankslate (~> 2.0)
- posix-spawn (0.3.8)
- pygments.rb (0.5.4)
- posix-spawn (~> 0.3.6)
- yajl-ruby (~> 1.1.0)
- rake (10.1.0)
- rb-fsevent (0.9.3)
- rb-inotify (0.9.3)
- ffi (>= 0.5.0)
- rb-kqueue (0.2.0)
- ffi (>= 0.5.0)
- rdiscount (2.1.7)
- redcarpet (2.3.0)
- safe_yaml (0.9.7)
- toml (0.1.0)
- parslet (~> 1.5.0)
- typhoeus (0.6.6)
- ethon (~> 0.6.1)
- yajl-ruby (1.1.0)
-
-PLATFORMS
- ruby
-
-DEPENDENCIES
- ffi (= 1.9.0)
- github-pages
- html-proofer
- rake
diff --git a/README.md b/README.md
index ee2b8ff..e78057a 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,24 @@
-# Choose a License Web Site [](https://travis-ci.org/github/choosealicense.com)
+# Choosealicense.com
+
+[](https://travis-ci.org/github/choosealicense.com)
Like a Choose Your Own Adventure site, but only much less interesting.
-# Intro
+## Intro
-A lot of repositories on GitHub.com don't have a license. GitHub provides
-a license chooser, but if you don't know anything about licenses, how are you
-supposed to make an informed decision?
+A lot of repositories on GitHub.com don't have a license. GitHub provides a license chooser, but if you don't know anything about licenses, how are you supposed to make an informed decision?
-ChooseALicense.com is designed to help people make an informed decision about
-licenses.
+[ChooseALicense.com](http://www.choosealicense.com "Choose A Licence website") is designed to help people make an informed decision about licenses.
-# Immediate Goals
+## Immediate Goals
-* Politics Free - Let's just not get into it.
+* Non-partisan. Our goal is to help you find a license that meets *your* goals.
* Well designed, but that goes without saying.
* The homepage should have just enough to help 99% of folks make a decision.
-* For the 1%, the site will contain a list of licenses common to specific
-communities and situations.
-* Not comprehensive. Seems like an odd goal, but there are a bajillion
-licenses out there. We're going to have to filter that down to a
-small list of those that matter.
+* For the 1%, the site will contain a list of licenses common to specific communities and situations.
+* Not comprehensive. Seems like an odd goal, but there are a bajillion licenses out there. We're going to have to filter that down to a small list of those that matter.
-# Run It On Your Machine
+## Run It On Your Machine
```bash
git clone https://github.com/github/choosealicense.com.git
@@ -32,49 +28,80 @@ script/server
```
Open `http://localhost:4000` in your favorite browser.
-# Adding a license
+## Adding a license
-The text of the license should be wrapped to a 78 character width.
+Licenses sit in the `/_licenses` folder. The text of the license should be wrapped to a 78 character width. Each license has YAML front matter describing the license's properties. The body of the file should be the text of the license in plain text. The available metadata fields are:
-Licenses sit in the `/licenses` folder. Each license has YAML front matter
-describing the license's properties. The body of the file should be the text
-of the license in plain text. The available metadata fields are:
+### YAML front matter
-* `title` - The name of the license
-* `layout` - This should be `license`
-* `permalink` - The absolute URL to the license, beginning with `/licenses/`
-* `source` - URL to the license source text
-* `note` - The note field in the sidebar (optional)
-* `how` - How to use the license, also in the sidebar
-* `required`, `permitted`, `forbidden` - bulleted list of rules applicable to the license (see below)
-* `filename` - The filename to be created on GitHub.com when a repository is initialized with this license.
+#### Required fields
-The licenses on choosealicense.com are regularly imported to GitHub.com to be
-used as the list of licenses available when creating a repository. When we
-create a repository, we will replace certain strings in the license with
-variables from the repository. These can be used to create accurate copyright
-notices. The available variables are:
+* `title` - The SPDX-compliant, human-readable license name
+* `source` - The URL to the license source text
+* `description` - A human-readable description of the license
+* `how` - Instructions on how to implement the license
+* `required` - Bulleted list of required rules
+* `permitted` - Bulleted list of permitted rules
+* `forbidden` - Bulleted list of forbidden rules
-* `[fullname]` - The full name or username of the repository owner
-* `[login]` - The repository owner's username
-* `[email]` - The repository owner's primary email address
-* `[project]` - The repository name
-* `[description]` - The description of the repository
-* `[year]` - The current year
+#### Optional fields
-# Rules
+* `note` - Additional information about the licenses
+* `using` - A list of notable projects using the license in the form of `project_name: "url"`
+* `hidden` - Whether the license is hidden from the license list (defaults to false)
+* `redirect_from` - Relative path(s) to redirect to the license from
+* `featured` - Whether the license should be featured on the main page (defaults to false)
+* `nickname` - A shorter, human-readable license name where the SPDX license name is long
+* `variant` - Whether the license is a variant of a family of licenses (e.g., GPL)
+* `category` - If part of a license family, the name of the license family (e.g., `GPL`)
+* `tab-slug` - If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters
-Rules (the license's properties) are stored as a bulleted list within the
-licenses YAML front matter. A full list of rules can be found in the
-repository's `_config.yml` file. Each rule has a name e.g.,
-`include-copyright`, a human-readable label, e.g., `Copyright inclusion`,
-and a description `Include the original copyright with the code`.
-To add a new rule, simply add it to `config.yml` and reference it in the
-appropriate license.
+### Auto-populated fields
-# License
+The licenses on choosealicense.com are regularly imported to GitHub.com to be used as the list of licenses available when creating a repository. When we create a repository, we will replace certain strings in the license with variables from the repository. These can be used to create accurate copyright notices. The available variables are:
-The content of this project itself is licensed under the
-[Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US),
-and the underlying source code used to format and display that content
-is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php).
+#### Fields
+
+* `fullname` - The full name or username of the repository owner
+* `login` - The repository owner's username
+* `email` - The repository owner's primary email address
+* `project` - The repository name
+* `description` - The description of the repository
+* `year` - The current year
+
+## License properties
+
+The license properties (rules) are stored as a bulleted list within the licenses YAML front matter. Each rule has a name e.g., `include-copyright`, a human-readable label, e.g., `Copyright inclusion`, and a description `Include the original copyright with the code`. To add a new rule, simply add it to `_data/rules.yml` and reference it in the appropriate license.
+
+### Rules
+
+#### Required
+
+* `include-copyright` - Include a copy of the license and copyright notice with the code.
+* `document-changes` - Indicate significant changes made to the code.
+* `disclose-source` - Source code must be made available when distributing the software. In the case of LGPL and OSL 3.0, the source for the library (and not the entire program) must be made available.
+* `network-use-disclose` - Users who interact with the software via network are given the right to receive a copy of the corresponding source code.
+* `library-usage` - The library may be used within a non-open-source application.
+* `rename` - You must change the name of the software if you modify it.
+
+#### Permitted
+
+* `commercial-use` - This software and derivatives may be used for commercial purposes.
+* `modifications` - This software may be modified.
+* `distribution` - You may distribute this software.
+* `sublicense` - You may grant a sublicense to modify and distribute this software to third parties not included in the license.
+* `private-use` - You may use and modify the software without distributing it.
+* `patent-grant` - This license provides an express grant of patent rights from the contributor to the recipient.
+
+#### Forbidden
+
+* `trademark-use` - While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
+* `no-liability` - Software is provided without warranty and the software author/license owner cannot be held liable for damages.
+* `no-sublicense` - You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+* `modifications` - This software may not be modified.
+* `distribution` - You may not distribute this software.
+* `sublicense` - You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+
+## License
+
+The content of this project itself is licensed under the [Creative Commons Attribution 3.0 license](http://creativecommons.org/licenses/by/3.0/us/deed.en_US), and the underlying source code used to format and display that content is licensed under the [MIT license](http://opensource.org/licenses/mit-license.php).
diff --git a/Rakefile b/Rakefile
index ed29cdb..fea4552 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1,7 +1,14 @@
require "html/proofer"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+ t.pattern = 'spec/**/*_spec.rb'
+ t.rspec_opts = ["--order", "rand", "--color"]
+end
task :test do
sh "bundle exec jekyll build --trace"
- # ignore href="#" for the "Copy to clipboard" button
- HTML::Proofer.new("./_site").run
+ HTML::Proofer.new("./_site", :check_html => true).run
+ Rake::Task["spec"].invoke
end
diff --git a/_config.yml b/_config.yml
index fa6bc0a..167a0e1 100644
--- a/_config.yml
+++ b/_config.yml
@@ -2,75 +2,44 @@
title: ChooseALicense.com
relative_permalinks: false
markdown: kramdown
+url: "http://choosealicense.com"
-rules:
+collections:
+ licenses:
+ output: true
+ permalink: /licenses/:path/
- required:
- - description: Include a copy of the license and copyright notice with the code.
- label: License and copyright notice
- tag: include-copyright
- - description: Indicate significant changes made to the code.
- label: State Changes
- tag: document-changes
- - description: Source code must be made available when distributing the software. In the case of LGPL, the source for the library (and not the entire program) must be made available.
- label: Disclose Source
- tag: disclose-source
- - description: The library may be used within a non-open-source application.
- label: Library usage
- tag: library-usage
- - description: You must change the name of the software if you modify it.
- label: Rename
- tag: rename
-
- permitted:
- - description: This software and derivatives may be used for commercial purposes.
- label: Commercial Use
- tag: commercial-use
- - description: This software may be modified.
- label: Modification
- tag: modifications
- - description: You may distribute this software.
- label: Distribution
- tag: distribution
- - description: You may grant a sublicense to modify and distribute this software to third parties not included in the license.
- label: Sublicensing
- tag: sublicense
- - description: You may use and modify the software without distributing it.
- label: Private Use
- tag: private-use
- - description: This license provides an express grant of patent rights from the contributor to the recipient.
- label: Patent Grant
- tag: patent-grant
-
- forbidden:
- - description: While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
- label: Use Trademark
- tag: trademark-use
- - description: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
- label: Hold Liable
- tag: no-liability
- - description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
- label: Sublicensing
- tag: no-sublicense
- - description: This software may not be modified.
- label: Modification
- tag: modifications
- - description: You may not distribute this software.
- label: Distribution
- tag: distribution
- - description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
- label: Sublicensing
- tag: sublicense
+defaults:
+ -
+ scope:
+ path: ""
+ type: "licenses"
+ values:
+ layout: license
+ featured: false
+ hidden: false
+ variant: false
exclude:
-- app.coffee
-- CNAME
-- CONTRIBUTING.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.md
-- licenses.json
-- Rakefile
-- README.md
-- script
-- vendor
+ - app.coffee
+ - CNAME
+ - CONTRIBUTING.md
+ - Gemfile
+ - Gemfile.lock
+ - LICENSE.md
+ - Rakefile
+ - README.md
+ - script
+ - vendor/bundle
+ - test
+ - tests
+ - assets/vendor/selectivizr/tests
+ - assets/vendor/zeroclipboard/test
+
+gems:
+ - jekyll-sitemap
+ - jekyll-redirect-from
+
+sass:
+ sass_dir: _sass
+ style: :compressed
diff --git a/_data/fields.yml b/_data/fields.yml
new file mode 100644
index 0000000..0b5f45d
--- /dev/null
+++ b/_data/fields.yml
@@ -0,0 +1,23 @@
+# The licenses on choosealicense.com are regularly imported to GitHub.com to
+# be used as the list of licenses available when creating a repository. When
+# we create a repository, we will replace certain strings in the license with
+# variables from the repository. These can be used to create accurate copyright
+# notices. The available variables are:
+
+- name: fullname
+ description: The full name or username of the repository owner
+
+- name: login
+ description: The repository owner's username
+
+- name: email
+ description: The repository owner's primary email address
+
+- name: project
+ description: The repository name
+
+- name: description
+ description: The description of the repository
+
+- name: year
+ description: The current year
diff --git a/_data/meta.yml b/_data/meta.yml
new file mode 100644
index 0000000..99b1d01
--- /dev/null
+++ b/_data/meta.yml
@@ -0,0 +1,68 @@
+# Each license has YAML front matter describing the license's properties.
+# The available fields are:
+
+- name: title
+ description: The SPDX-compliant, human-readable license name
+ required: true
+
+- name: source
+ description: The URL to the license source text
+ required: true
+
+- name: description
+ description: A human-readable description of the license
+ required: true
+
+- name: how
+ description: Instructions on how to implement the license
+ required: true
+
+- name: required
+ description: Bulleted list of required rules
+ required: true
+
+- name: permitted
+ description: Bulleted list of permitted rules
+ required: true
+
+- name: forbidden
+ description: Bulleted list of forbidden rules
+ required: true
+
+# Optional fields
+
+- name: note
+ description: Additional information about the licenses
+ required: false
+
+- name: using
+ description: 'A list of notable projects using the license in the form of `project_name: "url"`'
+ required: false
+
+- name: hidden
+ description: Whether the license is hidden from the license list (defaults to false)
+ required: false
+
+- name: redirect_from
+ description: Relative path(s) to redirect to the license from
+ required: false
+
+- name: featured
+ description: Whether the license should be featured on the main page (defaults to false)
+ required: false
+
+- name: nickname
+ description: A shorter, human-readable license name where the SPDX license name is long
+ required: false
+
+- name: variant
+ description: Whether the license is a variant of a family of licenses (e.g., GPL)
+ required: false
+
+- name: category
+ description: If part of a license family, the name of the license family (e.g., `GPL`)
+ required: false
+
+- name: tab-slug
+ description: If part of a license family, a license slug containing only `a-z`, `0-9`, and `_` characters
+ required: false
diff --git a/_data/rules.yml b/_data/rules.yml
new file mode 100644
index 0000000..0570871
--- /dev/null
+++ b/_data/rules.yml
@@ -0,0 +1,59 @@
+required:
+- description: Include a copy of the license and copyright notice with the code.
+ label: License and copyright notice
+ tag: include-copyright
+- description: Indicate significant changes made to the code.
+ label: State Changes
+ tag: document-changes
+- description: Source code must be made available when distributing the software. In the case of LGPL and OSL 3.0, the source for the library (and not the entire program) must be made available.
+ label: Disclose Source
+ tag: disclose-source
+- description: Users who interact with the software via network are given the right to receive a copy of the corresponding source code.
+ label: Network Use is Distribution
+ tag: network-use-disclose
+- description: The library may be used within a non-open-source application.
+ label: Library usage
+ tag: library-usage
+- description: You must change the name of the software if you modify it.
+ label: Rename
+ tag: rename
+
+permitted:
+- description: This software and derivatives may be used for commercial purposes.
+ label: Commercial Use
+ tag: commercial-use
+- description: This software may be modified.
+ label: Modification
+ tag: modifications
+- description: You may distribute this software.
+ label: Distribution
+ tag: distribution
+- description: You may grant a sublicense to modify and distribute this software to third parties not included in the license.
+ label: Sublicensing
+ tag: sublicense
+- description: You may use and modify the software without distributing it.
+ label: Private Use
+ tag: private-use
+- description: This license provides an express grant of patent rights from the contributor to the recipient.
+ label: Patent Grant
+ tag: patent-grant
+
+forbidden:
+- description: While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
+ label: Use Trademark
+ tag: trademark-use
+- description: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
+ label: Hold Liable
+ tag: no-liability
+- description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+ label: Sublicensing
+ tag: no-sublicense
+- description: This software may not be modified.
+ label: Modification
+ tag: modifications
+- description: You may not distribute this software.
+ label: Distribution
+ tag: distribution
+- description: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+ label: Sublicensing
+ tag: sublicense
diff --git a/_includes/css/normalize.min.css b/_includes/css/normalize.min.css
deleted file mode 100644
index 680db58..0000000
--- a/_includes/css/normalize.min.css
+++ /dev/null
@@ -1 +0,0 @@
-/*! normalize.css v2.1.3 | MIT License | git.io/normalize */article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block}audio:not([controls]){display:none;height:0}[hidden],template{display:none}html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}a{background:0 0}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{font-size:2em;margin:.67em 0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}mark{background:#ff0;color:#000}code,kbd,pre,samp{font-family:monospace,serif;font-size:1em}pre{white-space:pre-wrap}q{quotes:"\201C" "\201D" "\2018" "\2019"}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:0}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0}
\ No newline at end of file
diff --git a/_includes/footer.html b/_includes/footer.html
index 0cbe58b..d36ac59 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -15,19 +15,25 @@
- {% if page.layout == "license" or page.class == "license-types" %}
-
+ {% if page.collection == "licenses" or page.class == "license-types" %}
+
+
+
+
+
{% endif %}
-