diff --git a/about.md b/about.md index c4924282..1b5d5f2d 100644 --- a/about.md +++ b/about.md @@ -1,3 +1,43 @@ --- title: About --- + + +## Purpose + +This is my collection of reusable code samples and instructions, arranged in a way like recipes so that you can use an entire file to solve a task and not just look for one line like in a cheatsheet guide. + +Here you'll find code snippets in Jekyll, Bash, Python or JS. And some entire files you can copy in part or as a whole for your Makefile or deploy pipeline config. + + +## Background + +I have written and refined some of these recipes myself from my dev experience. Or I have copied from other sources like tutorials or other repos. I give credit as much as possible to the original source. Sometimes I don't even understand how a file works, but I know what it does and that it will be useful one day so I stash it as a reference in this centralized repo. This suits my learning style as I like to learn by example and real-world use, not just memorizing syntax and definitions. + +This collection approach I use it also great because I can collect code by myself or others which solves similar problems or the same problem (e.g. deploy a site) and then I can **compare** the solutions. I can choose one that makes sense for my situation or I can take the best parts from each solution and make a new entry, which becomes my go-to solution for keeping my projects consistent. + + diff --git a/index.md b/index.md index 2306f7a2..6aa4b72d 100644 --- a/index.md +++ b/index.md @@ -4,3 +4,40 @@ layout: home --- > {{ site.description }} + + + +Welcome to **Code Cookbook**. + +
+ + Go to recipes + +
+ + +## Featured topics + +- [Make][] + - Sample `Makefile` files. +- [CI/CD][] + - Many language-specific sample [workflows][] for GH Actions to test and deploy your app + - Plus some _Netlify_ configs. +- [SEO][] + - Recipes for `robots.txt` and `sitemap.xml` files. +- [Shell][] + - Usage help and examples for commands and patterns to use one or more commands to solve a real problem. Such as how to do find and replace using `find` or `sed` or how to clean up your git repo. +- [Jekyll][] + - Code snippets and configs +- [Containers][] + - Commands and configs for using Docket and k8s. + + +[Make]: {{ site.baseurl }}{% link recipes/make/index.md %} +[CI/CD]: {{ site.baseurl }}{% link recipes/ci-cd/index.md %} +[Workflows]: {{ site.baseurl }}{% link recipes/ci-cd/github-actions/workflows/index.md %} +[SEO]: {{ site.baseurl }}{% link recipes/seo/index.md %} +[Shell]: {{ site.baseurl }}{% link recipes/shell/index.md %} +[Jekyll]: {{ site.baseurl }}{% link recipes/jekyll/index.md %} +[Containers]: {{ site.baseurl }}{% link recipes/containers/index.md %} diff --git a/recipes/index.md b/recipes/index.md index 1f2b23f7..5d9bf661 100644 --- a/recipes/index.md +++ b/recipes/index.md @@ -2,3 +2,5 @@ layout: listing --- # Recipes + +Start here to browse topics and languages that interest you.