Skip to content

Commit

Permalink
README: Minor copyedits
Browse files Browse the repository at this point in the history
  • Loading branch information
basil-conto authored and shardulc committed Mar 4, 2024
1 parent 1e7e162 commit 8d78316
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ If you want to write a new article, add a new file in the corresponding director

**Note:** Please avoid changing the names of existing articles as this will change its permalink.

### Article header (YML front matter)
### Article header (YAML front matter)
In the first few lines of each article, please remember to include/update the following fields:
- `layout: post` (Just keep it like this)
- `title: "Candidacy exam"` (The full title of the article)
- `category: first` (Category as described in the previous section)
- `order: 1` (Order of the article in the category. Articles are sorted in ascending order on the guide index page.)

### How to write markdown
### How to write Markdown
The content of the articles can be written in Markdown and/or HTML.

If you are not familiar with Markdown syntax, take a look at [this guide](https://www.markdownguide.org/basic-syntax/).

**Note:** As the `h1` heading is reserved for the article title, please use `h2` (two hashtags in markdown `##`) or smaller headings within the article.
**Note:** As the `h1` heading is reserved for the article title, please use `h2` (two hashtags `##` in Markdown) or smaller headings within the article.

### How to make a pull request
To make a pull request, first fork this repository, make changes and commit to your fork, and come back here and click on "compare & pull request".
Expand All @@ -47,8 +47,7 @@ Edit [`index.md`](https://github.com/EPIC-guide/epic-guide.github.io/blob/main/i
If you would like to build the webpage locally to preview the changes:

1. Check (and install if not fulfilled) the [prerequisites](https://jekyllrb.com/docs/installation/#requirements): Ruby >= 2.5.0 with Dev headers, RubyGems, GCC and Make.
2. [Install Jeykll](https://jekyllrb.com/docs/installation/) following the steps according to your operating system.
3. Navigate to the root directory of this repo.
4. Run `jekyll serve` to start the server. It will automatically regenerate webpages when you change the Markdown sources.
4. Open a browser and go to [http://localhost:4000](http://localhost:4000).

1. [Install Jeykll](https://jekyllrb.com/docs/installation/) following the steps according to your operating system.
1. Navigate to the root directory of this repo.
1. Run `jekyll serve` to start the server. It will automatically regenerate webpages when you change the Markdown sources.
1. Open a browser and go to [http://localhost:4000](http://localhost:4000).

0 comments on commit 8d78316

Please sign in to comment.