Data

Tools

Indexes

Applications

Experiments

Open Source Science

sandboxbio-ifb-docs

https://github.com/ifb-elixirfr/sandboxbio-ifb-docs

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

Sandboxbio hosted by IFB documentation

Project layout

bash mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.

For collaborators and developers

This part is for collaborators and developers.

Modify content

When you are in the repository, add and/or modify your markdown tutorials in the docs directory. The arborescence of the website menu is to setup in the mkdocs.yml file.

Mkdocs

To work locally with this project, you'll have to follow the steps below:

  1. Fork, clone or download this project
  2. Create and activate conda env

bash cd sandboxbio-IFB-docs conda env create -f env_docs.yml conda activate docs

  1. Preview your project

bash mkdocs serve

Note : The site can be accessed under http://localhost:8000/

  1. Add content

Add/update markdown files in docs folder

  1. Test

bash mkdocs build

  1. Deploy

Only if previous command is Ok !

bash mkdocs gh-deploy --force

If you add an extension to (Material) MKdocs that requires the installation of a new package. Don't forget to export the conda environment (env_docs.yml) using the command line below.

bash conda env export --no-builds env_docs.yml

Read more at:

Citation

If you use our guide, please cite us :

IFB-ElixirFr, Sandbox.bio hosted by IFB documentation, https://github.com/IFB-ElixirFr/sandboxbio-IFB-docs

A DOI with Zenodo is comming.

Contributors

Contributing

Please, see the CONTRIBUTING file.

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See CODEOFCONDUCT file.

License

Our guide is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

CC BY-SA 4.0

Acknowledgement

  • All contributors

Ressources

mkdocs

  • Official documentation : https://www.mkdocs.org/
  • Material (best extension !) : https://squidfunk.github.io/mkdocs-material/
  • Multi language structure : https://github.com/squidfunk/mkdocs-material/discussions/2346

Owner

  • Name: Institut Français de Bioinformatique (IFB)
  • Login: IFB-ElixirFr
  • Kind: organization
  • Email: contact@groupes.france-bioinformatique.fr
  • Location: France

National Infrastructure of Bioinformatics, and French node of the ELIXIR ESFRI

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Denecker"
  given-names: "Thomas"
  orcid: "https://orcid.org/0000-0003-1421-7641"
- family-names: "Khamvongsa-Charbonnier"
  given-names: "Lucie"
  orcid: "https://orcid.org/0000-0002-1194-0546"
title: "IFB-ElixirFr/sandboxbio-IFB-docs"
version: 1.0.0
doi: 
date-released: 2023-07-24
url: "https://github.com/IFB-ElixirFr/sandboxbio-IFB-docs"

GitHub Events

Total
  • Release event: 1
  • Create event: 1
Last Year
  • Release event: 1
  • Create event: 1