Compare commits
5 commits
ac2c1c9680
...
d5bbcb36f5
Author | SHA1 | Date | |
---|---|---|---|
d5bbcb36f5 | |||
49141a225b | |||
0cce5d54cf | |||
70c6c223c4 | |||
5fd8e0b21e |
6 changed files with 235 additions and 185 deletions
342
LICENSE
342
LICENSE
|
@ -1,208 +1,202 @@
|
||||||
Apache License
|
|
||||||
|
|
||||||
Version 2.0, January 2004
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION,
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction, and distribution
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
as defined by Sections 1 through 9 of this document.
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
owner that is granting the License.
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all other entities
|
"Object" form shall mean any form resulting from mechanical
|
||||||
that control, are controlled by, or are under common control with that entity.
|
transformation or translation of a Source form, including but
|
||||||
For the purposes of this definition, "control" means (i) the power, direct
|
not limited to compiled object code, generated documentation,
|
||||||
or indirect, to cause the direction or management of such entity, whether
|
and conversions to other media types.
|
||||||
by contract or otherwise, or (ii) ownership of fifty percent (50%) or more
|
|
||||||
of the outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
granted by this License.
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications, including
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
but not limited to software source code, documentation source, and configuration
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
files.
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical transformation
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
or translation of a Source form, including but not limited to compiled object
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
code, generated documentation, and conversions to other media types.
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or Object form,
|
(a) You must give any other recipients of the Work or
|
||||||
made available under the License, as indicated by a copyright notice that
|
Derivative Works a copy of this License; and
|
||||||
is included in or attached to the work (an example is provided in the Appendix
|
|
||||||
below).
|
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object form,
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
that is based on (or derived from) the Work and for which the editorial revisions,
|
that You distribute, all copyright, patent, trademark, and
|
||||||
annotations, elaborations, or other modifications represent, as a whole, an
|
attribution notices from the Source form of the Work,
|
||||||
original work of authorship. For the purposes of this License, Derivative
|
excluding those notices that do not pertain to any part of
|
||||||
Works shall not include works that remain separable from, or merely link (or
|
the Derivative Works; and
|
||||||
bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including the original version
|
You may add Your own copyright statement to Your modifications and
|
||||||
of the Work and any modifications or additions to that Work or Derivative
|
may provide additional or different license terms and conditions
|
||||||
Works thereof, that is intentionally submitted to Licensor for inclusion in
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
the Work by the copyright owner or by an individual or Legal Entity authorized
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
to submit on behalf of the copyright owner. For the purposes of this definition,
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
"submitted" means any form of electronic, verbal, or written communication
|
the conditions stated in this License.
|
||||||
sent to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems, and
|
|
||||||
issue tracking systems that are managed by, or on behalf of, the Licensor
|
|
||||||
for the purpose of discussing and improving the Work, but excluding communication
|
|
||||||
that is conspicuously marked or otherwise designated in writing by the copyright
|
|
||||||
owner as "Not a Contribution."
|
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
of whom a Contribution has been received by Licensor and subsequently incorporated
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
within the Work.
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of this
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
Derivative Works of, publicly display, publicly perform, sublicense, and distribute
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
the Work and such Derivative Works in Source or Object form.
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of this License,
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
no-charge, royalty-free, irrevocable (except as stated in this section) patent
|
unless required by applicable law (such as deliberate and grossly
|
||||||
license to make, have made, use, offer to sell, sell, import, and otherwise
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
transfer the Work, where such license applies only to those patent claims
|
liable to You for damages, including any direct, indirect, special,
|
||||||
licensable by such Contributor that are necessarily infringed by their Contribution(s)
|
incidental, or consequential damages of any character arising as a
|
||||||
alone or by combination of their Contribution(s) with the Work to which such
|
result of this License or out of the use or inability to use the
|
||||||
Contribution(s) was submitted. If You institute patent litigation against
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
any entity (including a cross-claim or counterclaim in a lawsuit) alleging
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
that the Work or a Contribution incorporated within the Work constitutes direct
|
other commercial damages or losses), even if such Contributor
|
||||||
or contributory patent infringement, then any patent licenses granted to You
|
has been advised of the possibility of such damages.
|
||||||
under this License for that Work shall terminate as of the date such litigation
|
|
||||||
is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the Work or
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
Derivative Works thereof in any medium, with or without modifications, and
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
in Source or Object form, provided that You meet the following conditions:
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or Derivative Works a copy
|
END OF TERMS AND CONDITIONS
|
||||||
of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices stating that
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works that You distribute,
|
To apply the Apache License to your work, attach the following
|
||||||
all copyright, patent, trademark, and attribution notices from the Source
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
form of the Work, excluding those notices that do not pertain to any part
|
replaced with your own identifying information. (Don't include
|
||||||
of the Derivative Works; and
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its distribution,
|
Copyright [yyyy] [name of copyright owner]
|
||||||
then any Derivative Works that You distribute must include a readable copy
|
|
||||||
of the attribution notices contained within such NOTICE file, excluding those
|
|
||||||
notices that do not pertain to any part of the Derivative Works, in at least
|
|
||||||
one of the following places: within a NOTICE text file distributed as part
|
|
||||||
of the Derivative Works; within the Source form or documentation, if provided
|
|
||||||
along with the Derivative Works; or, within a display generated by the Derivative
|
|
||||||
Works, if and wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and do not modify the
|
|
||||||
License. You may add Your own attribution notices within Derivative Works
|
|
||||||
that You distribute, alongside or as an addendum to the NOTICE text from the
|
|
||||||
Work, provided that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and may provide
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
additional or different license terms and conditions for use, reproduction,
|
you may not use this file except in compliance with the License.
|
||||||
or distribution of Your modifications, or for any such Derivative Works as
|
You may obtain a copy of the License at
|
||||||
a whole, provided Your use, reproduction, and distribution of the Work otherwise
|
|
||||||
complies with the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise, any
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
Contribution intentionally submitted for inclusion in the Work by You to the
|
|
||||||
Licensor shall be under the terms and conditions of this License, without
|
|
||||||
any additional terms or conditions. Notwithstanding the above, nothing herein
|
|
||||||
shall supersede or modify the terms of any separate license agreement you
|
|
||||||
may have executed with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade names,
|
Unless required by applicable law or agreed to in writing, software
|
||||||
trademarks, service marks, or product names of the Licensor, except as required
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
for reasonable and customary use in describing the origin of the Work and
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
reproducing the content of the NOTICE file.
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or agreed to
|
|
||||||
in writing, Licensor provides the Work (and each Contributor provides its
|
|
||||||
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
||||||
KIND, either express or implied, including, without limitation, any warranties
|
|
||||||
or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR
|
|
||||||
A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness
|
|
||||||
of using or redistributing the Work and assume any risks associated with Your
|
|
||||||
exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory, whether
|
|
||||||
in tort (including negligence), contract, or otherwise, unless required by
|
|
||||||
applicable law (such as deliberate and grossly negligent acts) or agreed to
|
|
||||||
in writing, shall any Contributor be liable to You for damages, including
|
|
||||||
any direct, indirect, special, incidental, or consequential damages of any
|
|
||||||
character arising as a result of this License or out of the use or inability
|
|
||||||
to use the Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all other commercial
|
|
||||||
damages or losses), even if such Contributor has been advised of the possibility
|
|
||||||
of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing the Work
|
|
||||||
or Derivative Works thereof, You may choose to offer, and charge a fee for,
|
|
||||||
acceptance of support, warranty, indemnity, or other liability obligations
|
|
||||||
and/or rights consistent with this License. However, in accepting such obligations,
|
|
||||||
You may act only on Your own behalf and on Your sole responsibility, not on
|
|
||||||
behalf of any other Contributor, and only if You agree to indemnify, defend,
|
|
||||||
and hold each Contributor harmless for any liability incurred by, or claims
|
|
||||||
asserted against, such Contributor by reason of your accepting any such warranty
|
|
||||||
or additional liability. END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following boilerplate
|
|
||||||
notice, with the fields enclosed by brackets "[]" replaced with your own identifying
|
|
||||||
information. (Don't include the brackets!) The text should be enclosed in
|
|
||||||
the appropriate comment syntax for the file format. We also recommend that
|
|
||||||
a file or class name and description of purpose be included on the same "printed
|
|
||||||
page" as the copyright notice for easier identification within third-party
|
|
||||||
archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
|
|
||||||
limitations under the License.
|
|
||||||
|
|
43
README.md
43
README.md
|
@ -1,10 +1,12 @@
|
||||||
# recipe-site
|
# recipe-site
|
||||||
[![Build Status](https://drone.bune.city/api/badges/lynnesbian/recipe-site/status.svg)](https://drone.bune.city/lynnesbian/recipe-site)
|
[![Build Status](https://drone.bune.city/api/badges/lynnesbian/recipe-site/status.svg)](https://drone.bune.city/lynnesbian/recipe-site)
|
||||||
|
|
||||||
A simple static [Jekyll](https://jekyllrb.com) site for keeping track of recipes. This is my first major Jekyll project, so it might be a little messy.
|
A simple static [Jekyll](https://jekyllrb.com) site for keeping track of recipes. This is my first major Jekyll project, so it might be a little messy. **This project is a work in progress.**
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Ensure that you have [Git](https://git-scm.org), [Ruby](https://www.ruby-lang.org) and [RubyGems](https://rubygems.org/) installed.
|
Ensure that you have [Git](https://git-scm.org), [Ruby](https://www.ruby-lang.org) and [RubyGems](https://rubygems.org/) installed.
|
||||||
|
|
||||||
|
Assuming a Unix system:
|
||||||
```
|
```
|
||||||
$ git clone https://git.bune.city/lynnesbian/recipe-site
|
$ git clone https://git.bune.city/lynnesbian/recipe-site
|
||||||
$ cd recipe-site
|
$ cd recipe-site
|
||||||
|
@ -12,12 +14,13 @@ $ gem install bundler
|
||||||
$ bundle install
|
$ bundle install
|
||||||
$ bundle exec jekyll build
|
$ bundle exec jekyll build
|
||||||
```
|
```
|
||||||
This will compile the website into the `_site` directory, which you may serve with the HTTP server of your choice.
|
This will compile the website into the `_site` directory, which you may serve with any HTTP server. It is necessary to re-run `bundle exec jekyll build` after any modifications.
|
||||||
|
|
||||||
Alternatively, you can use jekyll's built in server for testing:
|
Alternatively, you can use jekyll's built in server for testing:
|
||||||
```
|
```
|
||||||
$ bundle exec jekyll serve
|
$ bundle exec jekyll serve
|
||||||
```
|
```
|
||||||
|
_The built in server will automatically regenerate the `_site` output whenever you make a change._
|
||||||
|
|
||||||
However, there won't be much to look at until you add some recipes!
|
However, there won't be much to look at until you add some recipes!
|
||||||
|
|
||||||
|
@ -26,7 +29,9 @@ Recipes are found in `_recipes/`, with subrecipes located in `_subrecipes/`.
|
||||||
|
|
||||||
Here's an example recipe, which could be saved to `_recipes/chocolate_cake.yml`:
|
Here's an example recipe, which could be saved to `_recipes/chocolate_cake.yml`:
|
||||||
```yaml
|
```yaml
|
||||||
|
---
|
||||||
name: Chocolate cake
|
name: Chocolate cake
|
||||||
|
author: Jane Crocker
|
||||||
layout: recipe
|
layout: recipe
|
||||||
|
|
||||||
ingredients:
|
ingredients:
|
||||||
|
@ -39,14 +44,18 @@ method:
|
||||||
- Whisk the egg finely
|
- Whisk the egg finely
|
||||||
# et cetera
|
# et cetera
|
||||||
time: 240
|
time: 240
|
||||||
|
---
|
||||||
```
|
```
|
||||||
- `name` (string) - The displayed name of the recipe. Does not appear in the URL.
|
- `name` (string) - The displayed name of the recipe. Does not appear in the URL.
|
||||||
|
- `author` (string, optional) - The author of the recipe.
|
||||||
- `layout` (string) - The template to use; should always be `recipe`.
|
- `layout` (string) - The template to use; should always be `recipe`.
|
||||||
- `ingredients` (list) - Each entry in `ingredients` consists of an amount, ingredient name, and unit terminology. `[2, flour, cups]` is displayed as `2 cups of flour`, while `[1, egg, null]` is displayed as `1 egg`.
|
- `ingredients` (list) - Each entry in `ingredients` consists of an amount, ingredient name, and unit terminology. `[2, flour, cups]` is displayed as `2 cups of flour`, while `[1, egg, null]` is displayed as `1 egg`. The third field is optional - `[1, egg, null]` is the same as `[1, egg]`.
|
||||||
- `method` (list) - A list of steps undertaken to create the recipe, written in plain English. Or whatever language you prefer.
|
- `method` (list) - A list of steps undertaken to create the recipe, written in plain English. Or whatever language you prefer.
|
||||||
- `time` (string) - The time it takes to make the recipe in minutes.
|
- `time` (string, optional) - The time it takes to make the recipe in minutes.
|
||||||
|
|
||||||
The recipe's file name isn't important, but it's good practice to make it something obvious, like `chocolate_cake.yml` and not `strawberry_pie.yml`.
|
The recipe's file name isn't important, but it's good practice to make it something obvious, like `chocolate_cake.md` and not `strawberry_pie.md`.
|
||||||
|
|
||||||
|
The recipe files are standard YAML. The extension should always be `.md` - other extensions will cause issues with subrecipes (see #1).
|
||||||
|
|
||||||
### Subrecipes
|
### Subrecipes
|
||||||
Subrecipes behave a little differently to regular recipes:
|
Subrecipes behave a little differently to regular recipes:
|
||||||
|
@ -56,9 +65,31 @@ Subrecipes behave a little differently to regular recipes:
|
||||||
|
|
||||||
Subrecipes have a tag that regular recipes do not - the `parents` tag. This is a list of recipes that the subrecipe should be included in. For example:
|
Subrecipes have a tag that regular recipes do not - the `parents` tag. This is a list of recipes that the subrecipe should be included in. For example:
|
||||||
```yaml
|
```yaml
|
||||||
|
---
|
||||||
name: Chocolate icing
|
name: Chocolate icing
|
||||||
parents:
|
parents:
|
||||||
- chocolate_cake
|
- chocolate_cake
|
||||||
- chocolate_cupcakes
|
- chocolate_cupcakes
|
||||||
|
ingredients:
|
||||||
|
- [250, chocolate, grams]
|
||||||
|
# et cetera
|
||||||
|
---
|
||||||
```
|
```
|
||||||
The entries in `parents` refer to the filenames of the parent recipes - `chocolate_cake` refers to `chocolate_cake.yml`.
|
The entries in `parents` refer to the filenames of the parent recipes - `chocolate_cake` refers to `chocolate_cake.md`.
|
||||||
|
|
||||||
|
If a subrecipe does not have at least one valid `parents` entry, it will not appear anywhere on the website.
|
||||||
|
|
||||||
|
### Licensing
|
||||||
|
This software is licensed under the [Apache 2.0 license](https://choosealicense.com/licenses/apache-2.0/).
|
||||||
|
|
||||||
|
Copyright 2020 Lynnesbian
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
3
_includes/footer.html
Normal file
3
_includes/footer.html
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
<footer>
|
||||||
|
<a href='/'>Home</a> - <a href='https://git.bune.city/lynnesbian/recipe-site'>Git</a>
|
||||||
|
</footer>
|
|
@ -8,7 +8,12 @@
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
{{ content }}
|
<div>
|
||||||
|
{{ content }}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{%- include footer.html -%}
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
layout: default
|
layout: default
|
||||||
---
|
---
|
||||||
{%- comment -%} this is a gross method of convertin "_recipes/example.md" to "example". it does it by removing the leading "_recipes/", which is simple enough, and then the trailing ".md", which is done by converting the string to an array, reversing it, turning it back into a string, removing the leading "dm." (".md" backwards), and doing the the array -> reverse -> string shuffle again. it's ugly but hey it works right {%- endcomment -%}
|
{%- comment -%} this is a gross method of converting "_recipes/example.md" to "example". it does it by removing the leading "_recipes/", which is simple enough, and then the trailing ".md", which is done by converting the string to an array, reversing it, turning it back into a string, removing the leading "dm." (".md" backwards), and doing the the array -> reverse -> string shuffle again. it's ugly but hey it works right {%- endcomment -%}
|
||||||
{%- assign id = page.path | remove_first: "_recipes/" | split: "" | reverse | join: "" | remove_first: "dm." | split: "" | reverse | join: "" -%}
|
{%- assign id = page.path | remove_first: "_recipes/" | split: "" | reverse | join: "" | remove_first: "dm." | split: "" | reverse | join: "" -%}
|
||||||
{%- comment -%} unfortunately we have to iterate through the entire subrecipe folder twice - once to see if there are any subrecipes that apply here, and another time to put them in. thankfully we can break out of the first loop if we find a single match. i miss jinja ;u; {%- endcomment -%}
|
{%- comment -%} unfortunately we have to iterate through the entire subrecipe folder twice - once to see if there are any subrecipes that apply here, and another time to put them in. thankfully we can break out of the first loop if we find a single match. i miss jinja ;u; {%- endcomment -%}
|
||||||
{%- assign applicable_subrecipes = false -%}
|
{%- assign applicable_subrecipes = false -%}
|
||||||
|
@ -14,7 +14,7 @@ layout: default
|
||||||
{%- endfor -%}
|
{%- endfor -%}
|
||||||
|
|
||||||
<h1>{{ page.name }}</h1>
|
<h1>{{ page.name }}</h1>
|
||||||
<p> {{ page.method.size }} steps - Estimated cooking time: {{ page.time | default: "Not provided" }}</p>
|
<p class='subtle'> {{ page.method.size }} steps - Estimated cooking time: {{ page.time | default: "Not provided" }} {% if page.author %} - By {{ page.author }} {% endif %}</p>
|
||||||
{%- if applicable_subrecipes %}
|
{%- if applicable_subrecipes %}
|
||||||
<h2> Subrecipes </h2>
|
<h2> Subrecipes </h2>
|
||||||
{% for subrecipe in site.subrecipes -%}
|
{% for subrecipe in site.subrecipes -%}
|
||||||
|
|
21
style.css
21
style.css
|
@ -1,8 +1,16 @@
|
||||||
body {
|
body {
|
||||||
font-family: sans-serif;
|
font-family: "DejaVu Sans", "Bitstream Vera Sans", "Helvetica", "Roboto", sans-serif;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
min-height: 100vh;
|
||||||
|
background: #fafafa;
|
||||||
}
|
}
|
||||||
|
body div {
|
||||||
|
flex-grow: 1;
|
||||||
|
}
|
||||||
|
|
||||||
.subrecipe {
|
.subrecipe {
|
||||||
background-color: #eee;
|
background: #eee;
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
}
|
}
|
||||||
.subrecipe h3 {
|
.subrecipe h3 {
|
||||||
|
@ -23,3 +31,12 @@ ul, ol {
|
||||||
list-style-position: inside;
|
list-style-position: inside;
|
||||||
padding-left: 10px;
|
padding-left: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
footer {
|
||||||
|
text-align: center;
|
||||||
|
margin: 20px auto;
|
||||||
|
}
|
||||||
|
footer, .subtle {
|
||||||
|
color: grey;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in a new issue