Skip to content

docs: add a .pdf designed cheat sheet printout - #226

Open
moabu wants to merge 2 commits into
tiimgreen:masterfrom
moabu:master
Open

docs: add a .pdf designed cheat sheet printout#226
moabu wants to merge 2 commits into
tiimgreen:masterfrom
moabu:master

Conversation

@moabu

@moabu moabu commented Jul 18, 2022

Copy link
Copy Markdown

Hey @tiimgreen,

I was working on a cheat sheet for GH and I stumbled on your awesome repo so I aligned the content accordingly thinking it might be interesting to have this printout available as well.

I am happy to update any content as needed in the future and if you have any comments on the file let me know here !

This PR adds a PDF printout of the cheat sheet as in the README.

published article: https://medium.com/@moabu/the-github-cheat-sheet-df4b3e3b42a8

@Technetium1

Copy link
Copy Markdown

Please generate the PDF via CI

@moabu

moabu commented Jul 19, 2022

Copy link
Copy Markdown
Author

@Technetium1 can you elaborate ? This pdf was generated with adobe illustrator and all the figures were created from scratch so there aren't any snapshots taken.What CI process do you mean? A workflow that generates the pdf from the readme ?

@Technetium1

Copy link
Copy Markdown

@moabu Yes! If you can separate the graphics, it can automatically be created from a workflow! Then it will always have the latest info in it. PDF generation doesn't take very much of the free CI time. I'm not sure how reasonable of a request that is for a first time contribution :\

@moabu

moabu commented Jul 19, 2022

Copy link
Copy Markdown
Author

It's possible . It requires a skimmed version of the readme and the graphics of course . We can then bundle that into a flow that automatically generates the pdf printout. The readme as is has too much to generate a concise cheat sheet.

What should be done:

  • Add summary sections to the main readme that will act as the cheat sheet text for each section.
  • Write a workflow that reads the main Readme and graphics folder (to be added) to generate a nice pdf.

I'm not so sure about how pretty the output can get with this approach but it's doable.

@mcmckns

mcmckns commented Oct 8, 2022

Copy link
Copy Markdown

When "if's and but's are candy and nuts, we'll all have a MERRY CHRISTMAS!!!!...........

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants