search

ShimantaBhuyan / markdown-portfolio

https://lab.github.com/courses/communicating-using-markdown
0 stars 0 forks source link

Getting started with this repo #1

Closed github-learning-lab[bot] closed 6 years ago

github-learning-lab[bot] commented 6 years ago

Welcome to your repository!

This repository is all about communicating with Markdown. The first thing to know about communicating with Markdown is that Markdown is an easy and widely used way to format your text.

This repository, and all of the activities you complete in it, will be working towards building a static webpage displaying your customized portfolio.

What is Markdown?

Markdown is a lightweight syntax for styling all forms of writing on the GitHub platform and the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *. You can use Markdown with the toolbar in Issues and Pull Requests, or you can learn the syntax and type it yourself.

You can use Markdown most places around GitHub:

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

Let's get started!

github-learning-lab[bot] commented 6 years ago

Step 1: Create a Task List

A task list creates checkboxes that can be checked off by collaborators in a given repository. They're very handy for tracking Issues, Pull Requests, and any to-do item.

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your Issue list. It also works in Pull Requests!

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

Example

- [x] @mentions, #refs, [links](url), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
  - Like this
- [x] this is a complete item
- [ ] this is an incomplete item

How it looks

:keyboard: Activity: Add a comment

  1. Add a comment to this issue

  2. Use Markdown to create a task list of todo items. Your task list could include any items you'd like, here's an example you can use:

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

  3. Use the Preview tab to check your markdown formatting

  4. 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

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds and refresh the page for your next steps.

ShimantaBhuyan commented 6 years ago
github-learning-lab[bot] commented 6 years ago

Step 2: Turn on GitHub Pages

Nicely done @ShimantaBhuyan! Your Markdown to-do list looks great. :sparkles:

Since this project is going to be a static web page, the first thing you'll need to do is turn on GitHub Pages. Here's how:

:keyboard: Activity: Enable GitHub Pages

  1. Click on the Settings tab for this repository.
  2. Use the Select source drop-down menu to select master as your GitHub Pages publishing source.
  3. Click Save.

You can find the full instructions and more information on GitHub Pages here.

Return to this issue for next steps

Turning on GitHub Pages creates a deployment of your repository. I may take up to a minute to respond as I await the deployment.

github-learning-lab[bot] commented 6 years ago

You did it! You can see the published site here: https://ShimantaBhuyan.github.io/markdown-portfolio/

Even though it may not look like much right now, 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!