Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…b.io into main
  • Loading branch information
Praneethsvch committed Sep 7, 2021
2 parents def7f3c + bfeccbf commit 5f79bbd
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
# 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

`cd floodsense.github.io`

`bundle install`
## Testing Locally

`bundle exec jekyll serve --config _config_local.yml`
```
cd floodsense.github.io
bundle install
bundle exec jekyll serve --config _config_local.yml
```



0 comments on commit 5f79bbd

Please sign in to comment.