Giter Club home page Giter Club logo

nfdi4chem / nmrxiv-docs Goto Github PK

View Code? Open in Web Editor NEW
1.0 3.0 0.0 53.55 MB

This documentation site is composed of detailed walk-through explanations for basic and more complex functionalities for both nmrXiv developers (Developer Guides) and users (Submission Guides). With our documentation-first approach we would like to allow nmrXiv developers and users to discuss proposed features and ensure that the implementations reflect the real use cases.

Home Page: https://docs.nmrxiv.org

License: MIT License

JavaScript 77.79% CSS 18.70% Dockerfile 3.51%
nmr nmr-spectra nmr-spectroscopy

nmrxiv-docs's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Maintained by

This project is developed and maintained by the NFDI4Chem partners at the Friedrich Schiller University Jena, Germany. The code for this web application is released under the MIT license.

NFDI4Chem Logo

Acknowledgments

Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under the National Research Data Infrastructure โ€“ NFDI4Chem โ€“ Projektnummer 441958208.

DFG Logo

nmrxiv-docs's People

Contributors

cs76 avatar nishasharma14 avatar nrayya avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

nmrxiv-docs's Issues

Citation conventions

Many pages contain information copies from other sources. We need to decide whether this is acceptable or plagiarism. And in all cases, in which form to provide citation (links in the text, references list..?)

Extend file format page

  • Fill in the Multi Domain Data Formats table after discussion with David
  • Add more columns to the other tables after discussion with David
  • Add the covered techniques to the Multi Domain Data Formats table.
  • Fix the citation when agreed on.

Move the content of current development-workflow to registration section

developer-guides/development-workflow

Development workflow - needs to have details of the code editor, code prettify plugin details etc.

Feature implementation flow

  1. Create a branch for the new feature
  2. Webpack watch command,
  3. Local email testing details
  4. Commit
  5. Pull request
  6. Review changes updated
  7. Merge
  8. Share / Testing on the staging site

Add NMRium

Add new page
General description
Potential features we are planning to implement in nmrXiv

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.