From ad9b870ebaf236ca5fc4652152fbc4cc1cdac573 Mon Sep 17 00:00:00 2001 From: Silin Gao <54292608+Silin159@users.noreply.github.com> Date: Tue, 13 Dec 2022 00:46:16 +0100 Subject: [PATCH] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 87b1a48ea..129af04b1 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ## Usage 1. Fork (copy) this repository by clicking the "Fork" button on the top right corner. 2. Go to "Settings" -> "Pages" in your forked repository. Under "Branch" change "None" to "master" and click "Save". -3. Edit the _config.yml file in your forked repository to change the site title (after "title:") and description (after "description:"). -4. Build your own page by editing this README.md (home page) and creating new .md files (other pages), formatting is done with standard [GitHub Markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), we provide an example file "example.md" in the repository. -**Important**: Please include "--- layout: default ---" (the first three line in "example.md") at the beginning of your every newly created .md file. -5. Add your new .md files to the site by editing the _config.yml file in your forked repository. Under "navigation:" add a new pair of "- title:" and "url:", and fill their value with your page name and .md file name. Remember to remove the "- title:" and "url:" pair for the example page. +3. Edit the `_config.yml` file in your forked repository to change the site title (after `title:`) and description (after `description:`). +4. Build your own page by editing this `README.md` (home page) and creating new `.md` files (other pages), formatting is done with standard [GitHub Markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), we provide an example file `example.md` in the repository. +**Important**: Please include ```--- layout: default ---``` (the first three line in `example.md`) at the beginning of your every newly created `.md` file. +5. Add your new `.md` files to the site by editing the `_config.yml` file in your forked repository. Under `navigation:` add a new pair of `- title:` and `url:`, and fill their value with your page name and `.md` file name. Remember to remove the `- title:` and `url:` pair for the example page. 6. Go back to "Settings" -> "Pages" to find your website link.