Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Praneethsvch committed Sep 7, 2021
1 parent e78c0c7 commit bfeccbf
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,22 @@
# floodsense.github.io
Documentation repo

How does this repo work?
## How does this repo work?

This repo is built based on [just-the-docs](https://github.com/pmarsceill/just-the-docs) Jekyll theme. The `docs` folder contains all the pages as markdowns. On top of the markdown add this table based on how you want to locate the file.

To add a file to the main index:
### To add a file to the main index:

| layout | title | nav_order |
| ------- | ------------ | ----------- |
| default | <title_here> | <nav_order> |

To add a file to a folder:
### To add a file to a folder:

Create a folder and place the markdown inside this folder, example:

| layout | title | parent | permalink |
| ------- | --------------------------- | ------------------ | ------------------------------------------------ |
| default | Quality Assurance Procedure | Quality Management | /quality-management/quality-assurance-procedure/ |

Testing Locally
## Testing Locally

```
cd floodsense.github.io
Expand Down

0 comments on commit bfeccbf

Please sign in to comment.