Skip to content

Commit

Permalink
continue setup
Browse files Browse the repository at this point in the history
  • Loading branch information
markwkidd committed Nov 18, 2024
1 parent 409d7d2 commit e966e80
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 33 deletions.
39 changes: 36 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,41 @@
title: Commonwealth Cushaw - Winter squash from seed to plate
description: An open repostory of information about cushaw cultivation and enjoyment
title: Commonwealth Cushaw
description: An open repostory of information about cushaw squash from seed to plate
theme: just-the-docs

url: https://markwkidd.github.io/cushaw-handbook
repository: markwkidd/crop-guides # for github-metadata

permalink: pretty

aux_links:
Template Repository: https://github.com/just-the-docs/just-the-docs-template
Commonwealth Cushaw Github Repository: https://github.com/markwkidd/cushaw-handbook

footer_content: "Copyright &copy; Going to Seed. Distributed by a <a href=\"https://creativecommons.org/licenses/by/4.0/\">CC BY 4.0 License.</a>"

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/markwkidd/cushaw-handbook" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
color_scheme: dark

callouts_level: quiet # or loud
callouts:
highlight:
color: yellow
important:
title: Important
color: blue
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red
9 changes: 9 additions & 0 deletions cultivation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Cushaw cultivation guide
layout: default
has_children: true
---

# Cushaw cultivation guide

This folder contains the cushaw crop guide, split into chronological chapters.
34 changes: 4 additions & 30 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,9 @@
---
title: Home
title: About the Commonwealth Cushaw project
layout: home
---

This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
## About this project

If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.

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

Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.

[Browse our documentation][Just the Docs] to learn more about how to use this theme.

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](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.

----

[^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).

[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
## About this guide
This guide is intended to be accessible to new and beginning gardeners and seed-savers as well as those with greater experience.
9 changes: 9 additions & 0 deletions recipes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Cushaw recipe collection
layout: default
has_children: true
---

# Cushaw recipe collection

This folder contains the cushaw recipes.

0 comments on commit e966e80

Please sign in to comment.