README.md

Wasm4Learn

Overview

Citation

Language

Continuous Integration

Questions

💬 Ask a question 📖 Report a problem or an idea

Contribution

Project layout

...
/components
    /content
        ...             # Component usable in content file (md)
    ...                 # content only usable by vue
/composables
    ...                 # function shared in all project
/layouts
    default.vue         # layout of the application
    home.vue            # layout of home page
/pages
    index.vue           # home page
    /language/[lang]/
        index.vue       # home page of language
        [...slug].vue   # How display content
    /learning-path/
        /all/index.vue  # All learning-path available
        [...slug].vue   # How display content
    /tool/[tool]/
        index.vue       # home page of language
        [...slug].vue   # How display content
    about.vue           # About page
    ... 
/plugins                # plugings used by application
    vuetify.js
    markdownit.ts
/publics                # assets available in all web site
    ...
    man/                # Man pages 
/store
    ...                 # Store declaration
nuxt.config.ts          # configuration file

!!! warning In public folder, webR files must be duplicated like content r folder

Highlight on nuxt.config.ts

Nuxt content and GitHub

Configuring Nuxt content to fetch content from GitHub

content: {
    sources: {
      github: {
        prefix: '', // Prefix for routes used to query contents
        driver: 'github', // Driver used to fetch contents (view unstorage documentation)
        repo: "IFB-ElixirFr/Wasm4Learn-content",
        branch: "main",
        dir: "content", // Directory where contents are located. It could be a subdirectory of the repository.
        // Imagine you have a blog inside your content folder. You can set this option to `content/blog` with the prefix option to `/blog` to avoid conflicts with local files.
      },
    },
    ...
}

Github pages

For the GitHub pages to work, the name of the repo must be specified in the config file.

app: {
    baseURL: '/Wasm4Learn/',
    ...
}
,

For collaborators and developers

This part is for collaborators and developers.

Nuxt 3 Minimal Starter

Look at the Nuxt 3 documentation to learn more.

Setup

Make sure to install the dependencies:

yarn install

Development Server

Start the development server on http://localhost:3000:

yarn dev

Production

Build the application for production:

yarn deploy

Check out the deployment documentation for more information.

Components to enrich markdown files

Read the documention available here

Citation

If you use our guide, please cite us :

IFB-ElixirFr, Wasm4learn, https://github.com/IFB-ElixirFr/sandboxbio-IFB-docs

Contributors

• Thomas Denecker
• Lucie Khamvongsa
• Imane Messak
• Anliat Mohamed

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 CODE_OF_CONDUCT file.

License

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

Acknowledgement

• All contributors

Ressources

• Nuxt.js
• Nuxt/content
• Vuetify 3
• vueJS 3
• webR
• Denis Puthier classes
• vue.draggable.next