Skip to content

Commit

Permalink
deploy: f816cb6
Browse files Browse the repository at this point in the history
  • Loading branch information
sukunis committed May 23, 2024
1 parent 4a71ca9 commit 65400e7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
8 changes: 6 additions & 2 deletions _sources/contributing/format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# YML format

In this repository, we store FAIR-IO materials using Markdown and for links a simple YML format. These files are structured like this:
In this repository, we store FAIR-IO materials using Markdown and for links we use a simple YML format.

Add **Markdown files** to the section folders under `docs` and register the file in `docs/_toc.yml`.

The **YML files** in `resources` are structured like this:

```
resources
Expand All @@ -22,4 +26,4 @@ These entries can have multiple properties:
* `authors` (optional)
* `tags` (optional)

This list of meta-data entries is extensible, just let us know using a [github-issue](https://github.com/NFDI4BIOIMAGE/FAIR-IO/issues) which kind of meta data you would like to add here.
This list of meta-data entries is extensible, just let us know using a [github-issue](https://github.com/NFDI4BIOIMAGE/FAIR-IO/issues) which kind of meta data you would like to add here.
4 changes: 3 additions & 1 deletion contributing/format.html
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,9 @@ <h1>YML format</h1>

<section class="tex2jax_ignore mathjax_ignore" id="yml-format">
<h1>YML format<a class="headerlink" href="#yml-format" title="Permalink to this heading">#</a></h1>
<p>In this repository, we store FAIR-IO materials using Markdown and for links a simple YML format. These files are structured like this:</p>
<p>In this repository, we store FAIR-IO materials using Markdown and for links we use a simple YML format.</p>
<p>Add <strong>Markdown files</strong> to the section folders under <code class="docutils literal notranslate"><span class="pre">docs</span></code> and register the file in <code class="docutils literal notranslate"><span class="pre">docs/_toc.yml</span></code>.</p>
<p>The <strong>YML files</strong> in <code class="docutils literal notranslate"><span class="pre">resources</span></code> are structured like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">resources</span>
<span class="o">-</span> <span class="n">name</span><span class="p">:</span> <span class="n">NFDI4BioImage</span> <span class="n">Website</span>
<span class="nb">type</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 65400e7

Please sign in to comment.