add placeholder guides

add placeholder guides heirarchy heirarchy heirarchy heirarchy heirarchy heirarchy heirarchy heirarchy heirarchy favicon cushaw homepage favicon remove top links add side links logo add side links add side links add side links favicon styles styles styles styles styles styles styles styles styles styles styles styles styles logo invert styles footer styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles logo logo styles styles favicon styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles styles organization organization organization styles styles cleanup styles styles styles styles styles styles styles styles styles styles styles layout updates page reneme styles paths paths paths styles styles menu fix cleanup renames paths rename file styles styles tweaks tweaks config tweaks path path favicon path nav order favicon eliminate page favicon logo fix heading styles paths paths styles image formatting image formatting images and readme styles styles styles styles styles styles styles border radius typo readme heading readme readme styles styles styles styles readme readme readme template template template template readme readme readme readme styles styles styles styles styles readme readme styles styles template readme readme readme template template template template template template template template template template template styles styles styles template styles template styles styles styles styles styles styles link link
adaptation-gardening · Dec 9, 2024 · 36a82f1 · 36a82f1
1 parent fd383d8
commit 36a82f1
Show file tree

Hide file tree

Showing 39 changed files with 663 additions and 366 deletions.
diff --git a/README.md b/README.md
@@ -1,174 +1,192 @@
-# just-the-docs-template
-
-This is a *bare-minimum* template to create a [Jekyll] site that:
-
-- uses the [Just the Docs] theme;
-- can be built and published on [GitHub Pages];
-- can be built and previewed locally, and published on other platforms.
-
-More specifically, the created site:
-
-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem;
-- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages.
-
-To get started with creating a site, simply:
-
-1. click "[use this template]" to create a GitHub repository
-2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
-
-If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo).
-
-After completing the creation of your new site on GitHub, update it as needed:
-
-## Replace the content of the template pages
-
-Update the following files to your own content:
-
-- `index.md` (your new home page)
-- `README.md` (information for those who access your site repo on GitHub)
-
-## Changing the version of the theme and/or Jekyll
-
-Simply edit the relevant line(s) in the `Gemfile`.
-
-## Adding a plugin
-
-The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin.
-
-To add an extra plugin, you need to add it in the `Gemfile` *and* in `_config.yml`. For example, to add [`jekyll-default-layout`]:
-
-- Add the following to your site's `Gemfile`:
-
-  ```ruby
-  gem "jekyll-default-layout"
-  ```
-
-- And add the following to your site's `_config.yml`:
-
-  ```yaml
-  plugins:
-    - jekyll-default-layout
-  ```
-
-Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
-
-## Publishing your site on GitHub Pages
-
-1.  If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to:
-
-    ```yaml
-    title: YOUR TITLE
-    description: YOUR DESCRIPTION
-    theme: just-the-docs
-
-    url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME
-
-    aux_links: # remove if you don't want this link to appear on your pages
-      Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME
-    ```
-
-2.  Push your updated `_config.yml` to your site on GitHub.
-
-3.  In your newly created repo on GitHub:
-    - go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`.
-    - if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`.
-
-## Building and previewing your site locally
-
-Assuming [Jekyll] and [Bundler] are installed on your computer:
-
-1.  Change your working directory to the root directory of your site.
-
-2.  Run `bundle install`.
-
-3.  Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`.
-
-    The built site is stored in the directory `_site`.
-
-## Publishing your built site on a different platform
-
-Just upload all the files in the directory `_site`.
-
-## Customization
-
-You're free to customize sites that you create with this template, however you like!
-
-[Browse our documentation][Just the Docs] to learn more about how to use this theme.
-
-## Hosting your docs from an existing project repo
-
-You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files.
-
-### Copy the template files
-
-1.  Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files.
-
-2.  Create a `docs` directory at your project root and copy all remaining template files into this directory.
-
-### Modify the GitHub Actions workflow
-
-The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root.
-
-1.  Set the default `working-directory` param for the build job.
-
-    ```yaml
-    build:
-      runs-on: ubuntu-latest
-      defaults:
-        run:
-          working-directory: docs
-    ```
-
-2.  Set the `working-directory` param for the Setup Ruby step.
-
-    ```yaml
-    - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-          cache-version: 0
-          working-directory: '${{ github.workspace }}/docs'
-    ```
-
-3.  Set the path param for the Upload artifact step:
-
-    ```yaml
-    - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/_site/
-    ```
-
-4.  Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy.
-
-    ```yaml
-    on:
-      push:
-        branches:
-          - "main"
-        paths:
-          - "docs/**"
-    ```
-
-## Licensing and Attribution
-
-This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
-
-The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].
-
-----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
-
-[Jekyll]: https://jekyllrb.com
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[Bundler]: https://bundler.io
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
-[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
-[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
-[MIT License]: https://en.wikipedia.org/wiki/MIT_License
-[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
-[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
+---
+title: Contributing to this project
+layout: default
+---
+
+# Contributing to this project
+
+The content of the guides is stored as [a GitHub repository](https://github.com/adaptation-gardening/crop-guides/). Contributions can be made directly in the form of Issues and Pull Requests. You may also post in the [Going to Seed Community Forum](https://goingtoseed.discourse.group/).
+
+The content of the guides is written in a relatively simple text syntax called Markdown. Link: [Guide to Markdown syntax](https://www.markdownguide.org/basic-syntax/).
+
+## Internal links
+When linking from one page to another inside the crop guides, a combination of Jekyll and Markdown syntax can be used.
+
+### Example: Internal Links
+* [Link to a crop guide document several layers into the tree]({% link guides/cucurbita/argyrosperma/index.md %})
+* [Link to the README document in the root level of the tree]({% link README.md %})
+
+#### Source
+{% raw %}
+```
+* [Link to a crop guide document several layers into the tree]({% link guides/cucurbita/argyrosperma/index.md %})
+* [Link to the README document in the root level of the tree]({% link README.md %})
+```
+{% endraw %}
+The path to the post, page, or collection is defined as the path relative to the root directory where the `config.yml` file is located, not the path from your existing page to the other page. Read more at: [https://jekyllrb.com/docs/liquid/tags/#link](https://jekyllrb.com/docs/liquid/tags/#link)
+
+## Images
+
+Images should be stored in `/assets/images`, within a subfolder that corresponds to the subfolder name of the 'primary' page that uses the image. An image related to a Cucurbita argyrsperma "Pumpkin Pie" recipe should be stored at a path like `/assets/images/cucurbita/argyrosperma/recipes/cushaw-pumpkin-pie`.
+
+### Using the `embed_image` template
+Images can be embedded using standard Markdown syntax, but this offers limited formatting options and does not provide a convenient method to caption images. A Jekyll template called `embed_image.html` offers the ability to embed an image with more flexibility than Markdown.
+
+#### `embed_image` parameters
+ * `url`
+ * `alt`
+ * `caption` - optional
+ * `thumbnail` - optional (do not use with width or height)
+ * `width` - optional (do not use with thumbnail)
+ * `height` - optional (do not use with thumbnail)
+
+### Example: Image without caption
+
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/cushaw-homepage-banner-1000x250.png"
+    alt="College of Cucurbita argyrosperma fruit in various situations"
+%}
+
+#### Source
+{% raw %}
+```
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/cushaw-homepage-banner-1000x250.png"
+    alt="College of Cucurbita argyrosperma fruit in various situations"
+%}
+```
+{% endraw %}
+
+### Example: Image with caption
+Invoke the template with a caption to wrap the image with the html element `figure` and add a caption wrapped in `figcaption`.
+
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/cushaw-homepage-banner-1000x250.png"
+    alt="College of Cucurbita argyrosperma fruit in various situations"
+    caption="Sometimes a caption adds valuable information that can't easily be conveyed any other way."
+%}
+
+#### Source
+{% raw %}
+```
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/cushaw-homepage-banner-1000x250.png"
+    alt="College of Cucurbita argyrosperma fruit in various situations"
+    caption="Sometimes a caption adds valuable information that can't easily be conveyed any other way."
+%}
+```
+{% endraw %}
+
+
+### Example: Wrap text around floating captioned image
+
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+The text in this paragraph wraps to the left side of the image, assuming the window is wide enough.
+
+#### Source
+{:class="clear-right"}
+
+{% raw %}
+```
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+```
+{% endraw %}
+
+### Example: A gallery of images
+
+Three thumbnail images can be placed in a row. The `<hr>` element or another element with `clear: right;` such as `<h1>` should be used after each row.
+
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+<hr>
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+<hr>
+
+#### Source
+{:class="clear-right"}
+
+{% raw %}
+```
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+<hr>
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+{% include embed_image.html
+    url="/assets/images/cucurbita/argyrosperma/recipes/cut-fruit-with-seeds-350w.jpg"
+    alt="Saved seeds in a colander"
+    caption="Seed saving and sharing is integrated into the guide"
+    thumbnail="true"
+%}
+<hr>
+```
+{% endraw %}