search

gofair-foundation / gofair-wiki

GO FAIR Wiki
https://wiki.gofair.foundation/
Other
1 stars 0 forks source link

readme

GO FAIR Wiki

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

The GO FAIR Wiki is an effort to bring together current individual documentation efforts into a comprehensive resource.

Authors: Barbara Magagna (https://orcid.org/0000-0003-2195-3997)

Contributors: Norbert van Dijk (https://orcid.org/0009-0003-5409-652X) Gerhard Burger (https://orcid.org/0000-0003-1062-5576) Anne Fouilloux (https://orcid.org/0000-0002-1784-2920)

Usage

The GO FAIR Wiki is build using Quarto (Markdown), to view/contribute follow these steps:

  1. Install Quarto (https://quarto.org/docs/get-started/, Step 1)
  2. (Recommended for beginners) Install RStudio
  3. Clone the repository

RStudio (recommended for beginners)

  1. Open the project by opening the gofair-wiki.Rproj file.
  2. In the Files tab (bottom right) open the index.qmd file.
  3. Click the Render button at the top of the editor, or use Ctrl+Shift+K\ NB: if nothing happens check the Background Jobs panel for the localhost link

At the top left of .qmd files you can switch to Visual mode if you're not familiar with Markdown yet.

VS Code

  1. Open the folder in VS Code
  2. Open the index.qmd file
  3. Click the Preview button at the top right, or use Ctrl+Shift+K

In both RStudio and VS Code the the preview will automatically update when you save changes to project files.

For more information on creating Quarto websites (e.g., adding pages) see https://quarto.org/docs/websites/.