Skip to content

Commit c6cd7e3

Browse files
bwbohlbwbohl
committed
jekyll build from Action 5067028 
0 parents  commit c6cd7e3

File tree

1,032 files changed

+561038
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,032 files changed

+561038
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
music-encoding.org

‎CONTRIBUTING.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Contributing Guidelines
2+
3+
If you wish to contribute changes to the MEI website, you can edit the files directly on GitHub. The website is written in a dialect of Markdown called [kramdown](https://kramdown.gettalong.org/quickref.html).
4+
5+
[//]: # (In the guidelines you will see links to "Edit this section". Clicking on this will open up an editor in GitHub, where you will be able to click on the 'pencil' to edit the text of the section.)
6+
7+
When you are finished, you can then “Propose a file change”, where you can write a brief summary of your changes and their motivations, and then “Create a Pull Request”, which will alert the MEI Technical Team of your proposed change. If there are any questions or problems with your suggested change, a discussion can happen on the Pull Request, and then it will be merged into the website.
8+
9+
In some cases you will see special markup that will create automatic contents. If you need help with this Markdown, the Technical Team will be happy to help.
10+
11+
For complex contributions, you may wish to get the website running on your local machine, and submit a larger Pull Request. This will be explained in the next section.
12+
13+
## Editing the website locally
14+
15+
If you wish to contribute significant changes, you will likely want to checkout the code from this repository and work on it locally. To do so you will need to install Jekyll, which requires Ruby. This guide will assume you have a functioning Ruby environment, with the `gem` and `bundle` commands available. If you do not, please follow [these instructions](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) on getting these set up.
16+
17+
### Step 1: Fork the website
18+
19+
You should fork the website into your own account using the “Fork” button on GitHub. This will make a copy of the music-encoding.github.io repository which you can edit.
20+
21+
### Step 2: Clone to local machine
22+
23+
In order to work with the repo offline you need to clone the code to your local machine, e.g. by clicking the green “Code” button at the top and following one of the corresponding instructions.
24+
25+
### Step 2: Create a new branch
26+
27+
Create a new branch for your changes on your local Git repository. You should make it a descriptive name, like ‘feature_new-project’, ‘fix_broken-links’ or similar.
28+
29+
### Step 3: Build and serve the website locally
30+
31+
For properly reviewing any changes made to your local copy of the MEI website in your browser, you need Jekyll to build and serve the page on your local machine. There are two recommended options for doing this:
32+
33+
a. Run Jekyll on your machine natively
34+
35+
b. Run Jekyll in a Docker container
36+
37+
#### Step 3a: Run Jekyll on your machine natively
38+
39+
To install and run Jekyll natively on your machine, please follow these steps:
40+
41+
1. Check prerequisites
42+
43+
Make sure you have Jekyll installed on your machine (needs Ruby under the hood). You can check by running `jekyll -v` in your terminal. If this does not succeed, try to follow the instructions given in the [Jekyll docs](https://jekyllrb.com/docs/). There a detailed installation guidelines for the most common operating systems ([https://jekyllrb.com/docs/installation/](https://jekyllrb.com/docs/installation/)).
44+
45+
2. Install Jekyll
46+
47+
Run `bundle install` in the root directory of your local clone of this repository. This will install all of the requirements for running the site locally.
48+
49+
3. Run the Jekyll server
50+
51+
You can run the Jekyll service locally with `bundle exec jekyll serve --baseurl=""`. This will compile the site and start serving the content locally. (If needed, you can add the option `-V` to get a more verbose output and information about the running compilation steps.) Once it's ready, you can open your browser and visit `http://localhost:4000` to see your local version of the website.
52+
53+
> [!TIP]
54+
> Pass the `--livereload` option to `serve` to automatically refresh the page with each change you make to the source files:
55+
>
56+
> `bundle exec jekyll serve --baseurl="" --livereload`
57+
58+
59+
#### Step 3b: Run Jekyll in a Docker container
60+
61+
To avoid installing Jekyll natively and to assure it comes with all the necessary dependencies, you can run it in a preconfigured container image. The publishers of Jekyll offer a corresponding Docker image for such purposes. To run it, please follow these instructions:
62+
63+
1. Install Docker
64+
65+
If not already installed on your machine, download and install Docker from [https://www.docker.com/](https://www.docker.com/).
66+
67+
2. Run Jekyll with Docker
68+
69+
Make sure to start docker before running the following command in the root directory of your local clone of this repository:
70+
71+
```bash
72+
docker run --rm -it --volume="$PWD:/srv/jekyll:Z" --publish 4000:4000 jekyll/jekyll jekyll serve
73+
```
74+
75+
Detailed explanations of this command can be found in the [Docker Command-line reference](https://docs.docker.com/engine/reference/run/) but here’s a concise explanation:
76+
77+
| Command Particle | Description |
78+
|:-----------------|:-----------------------------------------------------------------------------------------|
79+
| --rm | automatically clean up the container and remove the file system when the container exits |
80+
| --it | keeps the shell open |
81+
| --volume | mount a folder from the host as volume in container, here the current working directory (`$PWD`) gets mounted into `/srv/jekyll` in the docker container |
82+
| --publish | specifies the ports the container publishes |
83+
| jekyll/jekyll | the name of the Dockerimage |
84+
| jekyll serve | execute jekyll to serve the website |
85+
86+
This will compile the site and start serving the content locally. Information on the compilation process will be output to the command shell. Once it's ready, you can open your browser and visit `http://localhost:4000` to see your local version of the website.
87+
88+
### Step 5. Make your changes and commit
89+
90+
You should now be able to make your changes. Try to keep your commits as ‘atomic’ as possible; that is, commit only the changes necessary for a given set of functionality. Avoid large commits that change a lot of things, as this makes it harder to review your changes for unintended side effects and potential problems.
91+
92+
### Step 6. Propose a Pull Request
93+
94+
Once all of your changes have been committed and pushed to your fork, you can propose a change to the main music-encoding.github.io repository by opening a [Pull Request](https://help.github.com/articles/about-pull-requests/). This will alert the Technical Team that you have a change you wish to contribute. The 'Technical Team will review your changes and may ask for modifications or clarification in the Pull Request. Once your changes have been reviewed and accepted, they will be merged in and will then be available on the website.
95+
96+
### Step 7. Delete your local branch (optional)
97+
98+
When your pull request has been accepted, it is then safe to delete the branch that you created in Step 2. This will ensure you do not have older branches around that get progressively outdated.

‎LICENSE‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
Educational Community License
2+
3+
Version 2.0, April 2007
4+
5+
http://opensource.org/licenses/ECL-2.0
6+
7+
The Educational Community License version 2.0 ("ECL") consists of the Apache
8+
2.0 license, modified to change the scope of the patent grant in section 3 to
9+
be specific to the needs of the education communities using this license. The
10+
original Apache 2.0 license can be found at:
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14+
15+
1. Definitions.
16+
17+
"License" shall mean the terms and conditions for use, reproduction, and
18+
distribution as defined by Sections 1 through 9 of this document.
19+
20+
"Licensor" shall mean the copyright owner or entity authorized by the
21+
copyright owner that is granting the License.
22+
23+
"Legal Entity" shall mean the union of the acting entity and all other
24+
entities that control, are controlled by, or are under common control with
25+
that entity. For the purposes of this definition, "control" means (i) the
26+
power, direct or indirect, to cause the direction or management of such
27+
entity, whether by contract or otherwise, or (ii) ownership of fifty percent
28+
(50%) or more of the outstanding shares, or (iii) beneficial ownership of such
29+
entity.
30+
31+
"You" (or "Your") shall mean an individual or Legal Entity exercising
32+
permissions granted by this License.
33+
34+
"Source" form shall mean the preferred form for making modifications,
35+
including but not limited to software source code, documentation source, and
36+
configuration files.
37+
38+
"Object" form shall mean any form resulting from mechanical transformation or
39+
translation of a Source form, including but not limited to compiled object
40+
code, generated documentation, and conversions to other media types.
41+
42+
"Work" shall mean the work of authorship, whether in Source or Object form,
43+
made available under the License, as indicated by a copyright notice that is
44+
included in or attached to the work (an example is provided in the Appendix
45+
below).
46+
47+
"Derivative Works" shall mean any work, whether in Source or Object form, that
48+
is based on (or derived from) the Work and for which the editorial revisions,
49+
annotations, elaborations, or other modifications represent, as a whole, an
50+
original work of authorship. For the purposes of this License, Derivative
51+
Works shall not include works that remain separable from, or merely link (or
52+
bind by name) to the interfaces of, the Work and Derivative Works thereof.
53+
54+
"Contribution" shall mean any work of authorship, including the original
55+
version of the Work and any modifications or additions to that Work or
56+
Derivative Works thereof, that is intentionally submitted to Licensor for
57+
inclusion in the Work by the copyright owner or by an individual or Legal
58+
Entity authorized to submit on behalf of the copyright owner. For the purposes
59+
of this definition, "submitted" means any form of electronic, verbal, or
60+
written communication sent to the Licensor or its representatives, including
61+
but not limited to communication on electronic mailing lists, source code
62+
control systems, and issue tracking systems that are managed by, or on behalf
63+
of, the Licensor for the purpose of discussing and improving the Work, but
64+
excluding communication that is conspicuously marked or otherwise designated
65+
in writing by the copyright owner as "Not a Contribution."
66+
67+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
68+
of whom a Contribution has been received by Licensor and subsequently
69+
incorporated within the Work.
70+
71+
2. Grant of Copyright License.
72+
73+
Subject to the terms and conditions of this License, each Contributor hereby
74+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
75+
irrevocable copyright license to reproduce, prepare Derivative Works of,
76+
publicly display, publicly perform, sublicense, and distribute the Work and
77+
such Derivative Works in Source or Object form.
78+
79+
3. Grant of Patent License.
80+
81+
Subject to the terms and conditions of this License, each Contributor hereby
82+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
83+
irrevocable (except as stated in this section) patent license to make, have
84+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
85+
such license applies only to those patent claims licensable by such
86+
Contributor that are necessarily infringed by their Contribution(s) alone or
87+
by combination of their Contribution(s) with the Work to which such
88+
Contribution(s) was submitted. If You institute patent litigation against any
89+
entity (including a cross-claim or counterclaim in a lawsuit) alleging that
90+
the Work or a Contribution incorporated within the Work constitutes direct or
91+
contributory patent infringement, then any patent licenses granted to You
92+
under this License for that Work shall terminate as of the date such
93+
litigation is filed. Any patent license granted hereby with respect to
94+
contributions by an individual employed by an institution or organization is
95+
limited to patent claims where the individual that is the author of the Work
96+
is also the inventor of the patent claims licensed, and where the organization
97+
or institution has the right to grant such license under applicable grant and
98+
research funding agreements. No other express or implied licenses are granted.
99+
100+
4. Redistribution.
101+
102+
You may reproduce and distribute copies of the Work or Derivative Works
103+
thereof in any medium, with or without modifications, and in Source or Object
104+
form, provided that You meet the following conditions:
105+
106+
You must give any other recipients of the Work or Derivative Works a copy of
107+
this License; and You must cause any modified files to carry prominent notices
108+
stating that You changed the files; and You must retain, in the Source form of
109+
any Derivative Works that You distribute, all copyright, patent, trademark,
110+
and attribution notices from the Source form of the Work, excluding those
111+
notices that do not pertain to any part of the Derivative Works; and If the
112+
Work includes a "NOTICE" text file as part of its distribution, then any
113+
Derivative Works that You distribute must include a readable copy of the
114+
attribution notices contained within such NOTICE file, excluding those notices
115+
that do not pertain to any part of the Derivative Works, in at least one of
116+
the following places: within a NOTICE text file distributed as part of the
117+
Derivative Works; within the Source form or documentation, if provided along
118+
with the Derivative Works; or, within a display generated by the Derivative
119+
Works, if and wherever such third-party notices normally appear. The contents
120+
of the NOTICE file are for informational purposes only and do not modify the
121+
License. You may add Your own attribution notices within Derivative Works that
122+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
123+
provided that such additional attribution notices cannot be construed as
124+
modifying the License. You may add Your own copyright statement to Your
125+
modifications and may provide additional or different license terms and
126+
conditions for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use, reproduction, and
128+
distribution of the Work otherwise complies with the conditions stated in this
129+
License.
130+
131+
5. Submission of Contributions.
132+
133+
Unless You explicitly state otherwise, any Contribution intentionally
134+
submitted for inclusion in the Work by You to the Licensor shall be under the
135+
terms and conditions of this License, without any additional terms or
136+
conditions. Notwithstanding the above, nothing herein shall supersede or
137+
modify the terms of any separate license agreement you may have executed with
138+
Licensor regarding such Contributions.
139+
140+
6. Trademarks.
141+
142+
This License does not grant permission to use the trade names, trademarks,
143+
service marks, or product names of the Licensor, except as required for
144+
reasonable and customary use in describing the origin of the Work and
145+
reproducing the content of the NOTICE file.
146+
147+
7. Disclaimer of Warranty.
148+
149+
Unless required by applicable law or agreed to in writing, Licensor provides
150+
the Work (and each Contributor provides its Contributions) on an "AS IS"
151+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152+
implied, including, without limitation, any warranties or conditions of TITLE,
153+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You
154+
are solely responsible for determining the appropriateness of using or
155+
redistributing the Work and assume any risks associated with Your exercise of
156+
permissions under this License.
157+
158+
8. Limitation of Liability.
159+
160+
In no event and under no legal theory, whether in tort (including negligence),
161+
contract, or otherwise, unless required by applicable law (such as deliberate
162+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
163+
liable to You for damages, including any direct, indirect, special,
164+
incidental, or consequential damages of any character arising as a result of
165+
this License or out of the use or inability to use the Work (including but not
166+
limited to damages for loss of goodwill, work stoppage, computer failure or
167+
malfunction, or any and all other commercial damages or losses), even if such
168+
Contributor has been advised of the possibility of such damages.
169+
170+
9. Accepting Warranty or Additional Liability.
171+
172+
While redistributing the Work or Derivative Works thereof, You may choose to
173+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
174+
other liability obligations and/or rights consistent with this License.
175+
However, in accepting such obligations, You may act only on Your own behalf
176+
and on Your sole responsibility, not on behalf of any other Contributor, and
177+
only if You agree to indemnify, defend, and hold each Contributor harmless for
178+
any liability incurred by, or claims asserted against, such Contributor by
179+
reason of your accepting any such warranty or additional liability.
180+
181+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# The MEI Website
2+
3+
[![Check Links](https://github.com/music-encoding/music-encoding.github.io/actions/workflows/link-checker.yml/badge.svg)](https://github.com/music-encoding/music-encoding.github.io/actions/workflows/link-checker.yml)
4+
[![Jekyll Build](https://github.com/music-encoding/music-encoding.github.io/actions/workflows/jekyll.yml/badge.svg)](https://github.com/music-encoding/music-encoding.github.io/actions/workflows/jekyll.yml)
5+
[![License](https://img.shields.io/github/license/music-encoding/music-encoding.github.io)](https://github.com/music-encoding/music-encoding.github.io/blob/main/LICENSE)
6+
7+
This is the MEI website, available at [https://music-encoding.org](https://music-encoding.org).
8+
9+
## License
10+
11+
This repo is released under the [ECL-2.0](LICENSE), and original creations contributed to this repo are accepted under the same license.
12+
13+
## Contributing
14+
15+
For information about contributing and developing the website locally, please refer to the [Contributing Guidelines](CONTRIBUTING.md)
16+
17+
## Third-party components
18+
19+
### Spectre.css
20+
21+
The MEI website uses [Spectre.css](https://picturepan2.github.io/spectre/) as published at <https://github.com/picturepan2/spectre> under the terms of the MIT-license.
22+
23+
## Continuous integration and deployment
24+
25+
This website is being built automatically whenever a commit is pushed to the main branch.

0 commit comments

Comments
 (0)