|
1 | 1 | --- |
2 | 2 | title: About |
3 | 3 | --- |
| 4 | + |
| 5 | + |
| 6 | +## Purpose |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +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. |
| 11 | + |
| 12 | + |
| 13 | +## Background |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +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. |
| 18 | + |
| 19 | +<!-- delete or rewrite or move to new page |
| 20 | +
|
| 21 | +Sometimes the "recipe" in a directory is a group of scripts and possibly configs which work together. |
| 22 | +
|
| 23 | +Sometimes there is just a collection of ingredients which are similar and can be used in a larger recipe. For example, a collection of ESLint config files from various sources, or some boilerplate HTML and CSS to add an element to a Jekyll site. |
| 24 | +
|
| 25 | +I have a lot of template or "quickstart" repos on GitHub, but sometimes there are too specific for a larger setup. So this cookbook repo can take the most useful parts of those repos and put them in here as snippets with detail comments. This is a nice balance between entire files or projects which are not all relevant (or up to date) and giving one-line definitions of fields and allowed values. |
| 26 | +
|
| 27 | +A collection of answers to coding problems I come across, so I can refer back here to see what a few good approaches are. |
| 28 | +
|
| 29 | +Like a cheatsheet, but rather than one-line commands or code blocks, the answer is a longer file, a combination of files, or series of steps to follow. |
| 30 | +
|
| 31 | +Some answers will be boilerplate that you can copy to your project as is, with a few values possibly to configure. |
| 32 | +
|
| 33 | +Some content will be steps to follow in the command-line and not so much code to write. |
| 34 | +
|
| 35 | +The explanations are steps are more thorough than would fit in a cheatsheet and a cheatsheet would be more low-level pieces than a set of instructions. Though the emphasis is more on the content rather than steps to follow. |
| 36 | +
|
| 37 | +The solutions are based on my experienced or copied from other projects that I find, as a reference for how to something. |
| 38 | +
|
| 39 | +This project does not cover steps on install tools but rather how to use them. |
| 40 | +
|
| 41 | +This project is partly based on a principle in the book [Steal like an artist](https://www.amazon.com/Steal-Like-Artist-Things-Creative/dp/0761169253) which recommends making a stash of things that resonate with you and you can use an inspiration. Whether music, pictures, code... Note the book discourages plagiarism but focuses on the idea that nothing is truthy original, so use pieces that you find and rework them and make them yours in something new. This Code Cookbook is my collection or stash, using links and credits as much as possible to repos and docs, so I can draw on trusted examples when I need a reference. |
| 42 | +
|
| 43 | +--> |
0 commit comments