Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/metapsy-project/metapsyDocs

Repository of the Metapsy documentation website
https://github.com/metapsy-project/metapsyDocs

documentation meta-analysis psychotherapy

Last synced: 2 days ago
JSON representation

Repository of the Metapsy documentation website

Host: GitHub
URL: https://github.com/metapsy-project/metapsyDocs
Owner: metapsy-project
Created: 2022-05-16T16:12:13.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-10-31T08:48:51.000Z (16 days ago)
Last Synced: 2024-10-31T09:30:11.638Z (16 days ago)
Topics: documentation, meta-analysis, psychotherapy
Language: HTML
Homepage: https://docs.metapsy.org
Size: 21.4 MB
Stars: 2
Watchers: 0
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-psychology-projects - metapsy-project/metapsyDocs - open source platform with meta-analytic researches around psychotherapy (Psychotherapy / Tools for tests and experiments)

README

        # Repository of the Metapsy documentation website

This is the code repository of the [docs.metapsy.org](https://luxury-syrniki-6a53eb.netlify.app/) documentation website. 📄

## Using the Netlify CMS

The Metapsy documentation site is built using [Hugo](https://gohugo.io/). We have created a **Content Management System (CMS)** for the website, which is provided on [docs.metapsy.org/admin](https://docs.metapsy.org/admin). If you want to have access to the backend, please approach [@cyplessen](www.github.com/cyplessen), [@clara-miguel](www.github.com/clara-miguel), or [@MathiasHarrer](www.github.com/MathiasHarrer).

The forestry CMS provides you with a **code-free, visual text editor**. Using the CMS, you can change existing content, add new pages and entries, and upload media files.  After clicking on **save**, set the status to **ready**, and then click on **publish now**. Your changes are then **automatically deployed to this [Github repository](www.github.com/metapsy-project/metapsyDocs)**, and then released to the website shortly after.

### Pre-Defined Elements

Besides the visual editing functionality, there are also several **elements** that you can add to the documentation page via **shortcodes**. Here is an overview of the most important ones:

#### Zenodo DOI Badge 🛡️

Simply provide the "overall" (not version-specific) DOI created for the dataset or package. The badge will also automatically contain a link to the Zenodo repository.

```

{{< zenodo-badge doi="" >}}

```

#### Zenodo GitHub Release Link 😺

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

The link text to be displayed can be specified in `text`.

```

{{< zenodo-github-release doi="" text="link" >}}

```

#### Zenodo Last Update Date 📅

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-last-updated doi="" >}}

```

#### Zenodo Last Search Date 🔍

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-last-search doi="" >}}

```

#### Zenodo Latest Version 🔢

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-version doi="" >}}

```

#### Zenodo "Browse All Versions" Block 🔢

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-all-versions doi="" >}}

```

#### Zenodo Database Authors ✍🏽

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-authors doi="" >}}

```

#### Zenodo Variable Description 📓 

Simply provide the "overall" (not version-specific) DOI created for the dataset or package.

```

{{< zenodo-variable-description doi="" >}}

```

#### Note Box 🗒️

```

{{< notice note >}}

This is a simple note.

{{< /notice >}}

```

#### Tip Box 💡

```

{{< notice tip >}}

This is a simple tip.

{{< /notice >}}

```

#### Info Box ℹ️

```

{{< notice info >}}

This is a simple info.

{{< /notice >}}

```

#### Warning Box ⚠️

```

{{< notice warning >}}

This is a simple warning.

{{< /notice >}}

```

#### Tabs 📂

```

{{< tabs >}}

{{< tab "first" >}}

This is first tab

{{< /tab >}}

{{< tab "second" >}}

this is second tab

{{< /tab >}}

{{< tab "third" >}}

this is third tab

{{< /tab >}}

{{ tabs >}}

```

#### R Code Chunk

To create an R code chunk, start with three [backticks](https://www.wikiwand.com/en/Backtick) and `r`, and end your code example with three backticks.

#### Tables 📈

Colons can be used to align columns.

```

| Tables        |      Are      |  Cool |

| ------------- | :-----------: | ----: |

| col 3 is      | right-aligned | $1600 |

| col 2 is      |   centered    |   $12 |

| zebra stripes |   are neat    |    $1 |

```

There must be at least 3 dashes separating each header cell.

The outer pipes (`|`) are optional, and you don't need to make the

raw Markdown line up prettily. You can also use inline Markdown.

```

| Markdown | Less      | Pretty     |

| -------- | --------- | ---------- |

| _Still_  | `renders` | **nicely** |

| 1        | 2         | 3          |

```

### Media Upload

Using the `Media` menu in the CMS, you can upload images, PDFs, files etc. After the upload, files are saved in the `images/uploads` folder. So, if you want to use e.g. `sample.pdf` in a documentation entry, you have to use `images/uploads/sample.pdf` as the URL. 

**Please note that all uploads go directly into the Github repo of this website!** So please only upload files that are actually used in the documentation, and make sure that the size is below 50MB.

### Attribution

The website uses the [dot-hugo](https://github.com/themefisher/dot-hugo) theme as basis.