From e3985017fbfbb6fd29b51f295b71185b48c92e4f Mon Sep 17 00:00:00 2001 From: Daniel <57362494+daniel-panhead@users.noreply.github.com> Date: Sat, 28 Oct 2023 03:29:48 -0700 Subject: [PATCH] Add status badges and link to other docs (#66) --- NOTEBOOK.md => COMPONENTS.md | 3 +-- README.md | 25 ++++++++++--------------- 2 files changed, 11 insertions(+), 17 deletions(-) rename NOTEBOOK.md => COMPONENTS.md (99%) diff --git a/NOTEBOOK.md b/COMPONENTS.md similarity index 99% rename from NOTEBOOK.md rename to COMPONENTS.md index a778870..dba9ad7 100644 --- a/NOTEBOOK.md +++ b/COMPONENTS.md @@ -1,6 +1,5 @@ # Notebook & General Documentation -You're welcome. \ Co-author: Daniel + Minh :D # General Documentation @@ -12,7 +11,7 @@ Wrapper component to detect if the user click outside of your component. First, - `yourCallBackFunc` - the method that will be called when the user clicks outside of your component. You have to define this yourself. It varies depending on the need. - `setRef` - is a function from `` that allows you to to specify the Ref of the target component. With it, we can check if the component has been clicked, whenever there's a click. -```html +```vue ... diff --git a/README.md b/README.md index b307439..94302c2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,11 @@ +![CI Workflow](https://github.com/biomod2023/biomod2023/actions/workflows/continuous-integration.yaml/badge.svg) +[![Netlify Status](https://api.netlify.com/api/v1/badges/db2001c1-35a1-425d-b94f-1d4fb84e92f0/deploy-status)](https://app.netlify.com/sites/biomod2023/deploys) + # Biomod 2023 Website This is the website for Biomod's 2023 project submission. -## Recommended IDE Setup - -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. - -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: - -1. Disable the built-in TypeScript Extension - 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette - 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. +See [THEME.md](./THEME.md) for Tailwind CSS theme documentation and [COMPONENTS.md](./COMPONENTS.md) for our custom component documentation, including Lab Notebook template components. ## Project Setup @@ -39,4 +29,9 @@ npm run build ```sh npm run lint -``` \ No newline at end of file +``` + +### Prettify Code Formatting + +```sh +npm run format \ No newline at end of file