Skip to content

Instantly share code, notes, and snippets.

@kruttik-lab49
Last active September 30, 2020 21:45
Show Gist options
  • Select an option

  • Save kruttik-lab49/9ae9d751f442c7718b90084fe0d5bc4e to your computer and use it in GitHub Desktop.

Select an option

Save kruttik-lab49/9ae9d751f442c7718b90084fe0d5bc4e to your computer and use it in GitHub Desktop.
TWL-Lab49/How to post a TWL using Github gists

logo

TWL posts are fetched from the GitHub API, and the visibility of posts is based on a few parameters:

  1. The author is part of the Lab49 GitHub organization, or is whitelisted as a guest or alumnus
  2. The title of the Gist starts with "TWL-Lab49/"
  3. The Gist is public

Post guidelines

Start your post title with "TWL-Lab49/". Your post title should look something like this:

title

Please use full, well formed, descriptive sentences in your title. We expect to be able to use the title contents for building search features in the future.

Posts should generally be fairly short, quick to read, and easy to understand. Consider each post to be a single, fun, interesting tip that somebody could use in their projects right away. We expect that most posts will be discovered by people searching Google for answers to issues they're running into on their projects.

Within each post, it's typically best to make your files Markdown, and use the GitHub Flavored Markdown code blocks to format code.

Here's an example of a short post, in Markdown format, with a TypeScript code sample:

code-sample

You can add as many files to your Gist as you like, but please be aware of how the embedded Gist will be displayed on Today, We Learned.

Posts will be available in production immediately, but you can still edit posts as needed to correct formatting and content mistakes. Edits will be available immediately.

If you need further assistance, please reach out to the following people:

  1. Brian McAllister [email protected]
  2. Kruttik Aggarwal [email protected]
  3. Mike Merrin [email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment