Skip to content

Commit

Permalink
Documentation for how to create a FAQ and merge into README
Browse files Browse the repository at this point in the history
* add documentation for how to create a FAQ

* Complete the merge of #546 by hand

* Reinsert third point

---------

Co-authored-by: Muhammad Haroon <[email protected]>
Co-authored-by: Devin Ulibarri <[email protected]>
  • Loading branch information
3 people authored Nov 18, 2024
1 parent 4a675b2 commit 3ad2908
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,3 +349,26 @@ In this section, we will guide you through the steps for creating a new blog pos

5. **Save and Preview:**
* Save the file, then run `jekyll serve` in your terminal to start the local server. Visit `http://localhost:4000` to preview your blog post.

### How to create a FAQ?
In this section, we will guide you through the steps for creating a new FAQ.

1. **Navigate to the _faqs directory:**
* In the site's main directory, open the _faqs folder. This is where all your FAQ posts are stored.

2. **Create a New Markdown File:**
* Create a new file in the _faqs folder.

3. **Add Front Matter:**
* At the top of your new file, add front matter between `---` lines. This metadata tells Jekyll how to handle the post. Here’s a basic template:

```
---
question: "The question you want to add"
answer: "The answer to that question"
---
```

4. **Save and Preview:**
* Save the file, then run `jekyll serve` in your terminal to start the local server. Visit `http://localhost:4000` to preview your FAQ.

0 comments on commit 3ad2908

Please sign in to comment.