Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 20 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,36 @@
# NeuroImaging Quality Control (niQC)

Repository for the niQC website.
Welcome to the **niQC** repository! This project hosts the website for NeuroImaging Quality Control.

## Basic Structure

This website is built over Gatsby, a static site generator. After each commit on branch `master`, it will rebuild the entire website with the new changes and deploy it to https://incf.github.io/niQC/

All the content is inside the folder `content` in Markdown format.

To create a new page, follow the structure of pages under `content/pages`. It requires a folder, containing an `index.md` file.
The `index.md` file may contain the page content, with the following header:

```markdown
---
path: "/about"
title: "About"
menu: 4
---

# About!
```
## Website Structure

The `path` key indicates the URL for the page. In the example, the full URL will be: `https://incf.github.io/niQC/about`. A trailing slash is not required.
The niQC website is built with **Gatsby**, a fast and modern static site generator. Every commit pushed to the `master` branch triggers a rebuild of the website and deployment to:

The `title` key indicates the page title, replicated on the page title tag (`<title>`) and in the beginning of the page.
[https://incf.github.io/niQC/](https://incf.github.io/niQC/)

The `menu` key indicates if the page should be shown in the header menu. If `menu` is lesser then one, it will not be displayed in the menu.
---

Everything beyond the last `---` will be considered page content.
## Content Organization

## How to collaborate
All website content is stored in the `content` folder in **Markdown (`.md`) format**.

In order to suggest modifications, you need to open a pull request from your fork of this website. After proper review, your code will be merged into the `master` branch.
To create a new page:

Steps:
- Fork the [niQC repo](https://github.com/INCF/niQC/fork)
- Find the page you would like to contribute to under `content/pages` and edit the `index.md` markdown page
- Send us pull a request
- If you are confused or having trouble, just [open an issue](https://github.com/INCF/niQC/issues/new) at the .

Thank you for your interest in contributing to this effort.
1. Navigate to `content/pages`.
2. Create a new folder for your page.
3. Inside the folder, add an `index.md` file containing your page content.

## Running locally using Docker
### Example `index.md`:

You can start a development server using Docker:
```markdown
---
path: "/about"
title: "About"
menu: 4
---

```bash
docker run -it -p 9000:9000 -v `pwd`:/opt/code -w /opt/code node:11.15.0 bash -c 'npm i; npm run develop'
```
# About!

This command will spawn a container, install the required dependencies for the project, and start the development server. You can access it at `http://localhost:9000`. The website content will be recompiled and refreshed every time a file is changed.
Welcome to the About page!