baiden/markdown-portfolio

Getting Started with GitHub

github-learning-lab opened this issue · 4 comments

github-learning-lab commented

Welcome to your repository!

In this repository 📖, you’ll learn how to write with Markdown 📖, a simple and widely used markup language for formatting text. Here, you’ll start building a static webpage for your customized portfolio.

What is Markdown?

Markdown is a lightweight syntax for communicating on GitHub, and many other websites. You can format words as bold or italic, add images, and create lists. Markdown is regular text combined with a few non-alphabetic symbols, such as # or *. You can use Markdown with the formatting toolbar in issues đź“– and pull requests đź“–, or you can type the syntax.

You can use Markdown most places around GitHub:

  • Comments in issues and pull requests (like this one!)
  • Files with the .md or .markdown extension
  • Sharing snippets of text in Gists

For more information, see “Writing on GitHub” in the GitHub Help.

Let's get started!

github-learning-lab commented

Step 1: Create a Task List

A task list creates checkboxes for people with access đź“–in a repository to check off. They're very useful for tracking issues and pull requests.

If you include a task list in the body of an issue or pull request, you'll see a progress indicator in your issue list.

Watch out! The syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't render.

Example markup

- [x] Additional markup is supported, including @mentions, #references, [links](url), **emphasis**, and <del>HTML tags</del>.
- [x] List syntax is required.
  - You can nest lists below, too!
- [x] This item is completed.
- [ ] This item is not complete.

Rendered

  • Additional markup is supported, including @mentions, #references, links, emphasis, and HTML tags.
  • List syntax is required.
    • You can nest lists below, too!
  • This item is complete.
  • This item is not complete.

⌨️ Activity: Add a comment

  1. Add a comment to this issue, using Markdown to create a list of items to complete. Your task can include any tasks you wish, or you can use this example:

    - [ ] Turn on GitHub Pages
- [ ] Outline my portfolio
- [ ] Introduce myself to the world

  2. Use the Preview tab to check your markdown formatting.

  3. Click Comment.

For a printable version of the steps in this course, check out the Quick Reference Guide.

Watch below your comment for my response.

If you perform an expected action and don't see a response from me after a few seconds, refresh the page for your next steps.

baiden commented
  • Turn on GitHub Pages
  • Outline my portfolio
  • Introduce myself to the world
github-learning-lab commented

Step 2: Turn on GitHub Pages

Nicely done @baiden!

Now let's turn our focus to the content of your portfolio. Because this portfolio will display as a static web page, you'll need to enable GitHub Pages.

⌨️ Activity: Enable GitHub Pages

  1. Under your repository name at the upper right, click ⚙️ Settings.
  2. Then on the lower left, click Pages
  3. In the GitHub Pages section, use the Select source drop-down menu to select main as your GitHub Pages publishing source.
  4. Click the Save button.
  5. Read the page. Make no changes to the Theme. When ready under your repository name at the upper right click Issues(1)
  6. Then click on closed
  7. Then click on "Getting Started with GitHub" issue and scroll down to find your last progress and instruction for the next step.

I may take up to a minute to respond as I wait for GitHub Pages to create a deployment of your repository.

For more information, see Configuring a publishing source for GitHub Pages in the GitHub Help.

Return to this issue for next steps.

github-learning-lab commented

Take a look at your published site here: https://baiden.github.io/markdown-portfolio/

As we add content throughout the course, this site will update.

I've closed this issue and opened a pull request for you to work on headers in your portfolio.

Go to the pull request now!