|
1 | 1 | # Code Cookbook 👩💻👨🍳📖🥗 |
2 | 2 | > Reusuable code patterns which you can use as reference or copy to your project |
3 | 3 |
|
4 | | -<!-- |
| 4 | +<!-- too noisy so stop it |
5 | 5 |  |
6 | 6 | --> |
7 | 7 |
|
8 | | -This 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. |
| 8 | +## Cookbook |
| 9 | + |
| 10 | +### Menu |
| 11 | + |
| 12 | +- [recipes](/recipes/) - browse categories and languages that interest you. |
| 13 | + |
| 14 | +### Highlights |
| 15 | + |
| 16 | +Here are some highlights of this project: |
| 17 | + |
| 18 | +- [CI/CD](/recipes/ci-cd) |
| 19 | + - Many language-specific sample [workflows](https://github.com/MichaelCurrin/code-cookbook/tree/master/recipes/ci-cd/github-actions/workflows) for GH Actions to test and deploy your app |
| 20 | + - Plus some Netlify configs |
| 21 | +- SEO |
| 22 | + - [robots.txt](/recipes/robots/) |
| 23 | + - [sitemap.xml](/recipes/sitemap/) |
| 24 | +- [Shell](/recipes/shell/) - usage help for commands and examples or patterns to use them. Such as using `find` or `grep`. |
| 25 | +- [Jekyll](/recipes/jekyll/) - code snippets and configs |
| 26 | +- [Containers](/recipes/containers) - commands and configs for using Docket and k8s. |
| 27 | + |
| 28 | + |
| 29 | +## Purpose |
| 30 | + |
| 31 | +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 | 32 |
|
10 | 33 | 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 | 34 |
|
12 | | -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 orginal 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. |
| 35 | + |
| 36 | +## Background |
| 37 | + |
| 38 | +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 orginal 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. |
| 39 | + |
| 40 | +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. |
13 | 41 |
|
14 | 42 | <!-- TODO move to About section or new page. |
15 | 43 |
|
@@ -37,18 +65,6 @@ This project is partly based on a principle in the book [Steal like an artist](h |
37 | 65 |
|
38 | 66 | --> |
39 | 67 |
|
40 | | -Here are some highlights of this project: |
41 | | - |
42 | | -- [CI/CD](/recipes/ci-cd) |
43 | | - - Many language-specific sample [workflows](https://github.com/MichaelCurrin/code-cookbook/tree/master/recipes/ci-cd/github-actions/workflows) for GH Actions to test and deploy your app |
44 | | - - Plus some Netlify configs |
45 | | -- SEO |
46 | | - - [robots.txt](/recipes/robots/) |
47 | | - - [sitemap.xml](/recipes/sitemap/) |
48 | | -- [Shell](/recipes/shell/) - usage help for commands and examples or patterns to use them. Such as using `find` or `grep`. |
49 | | -- [Jekyll](/recipes/jekyll/) - code snippets and configs |
50 | | -- [Containers](/recipes/containers) - commands and configs for using Docket and k8s. |
51 | | - |
52 | 68 |
|
53 | 69 | ## License |
54 | 70 |
|
|
0 commit comments