Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup Mermaid for Docusaurus #3150

Merged
merged 1 commit into from
Mar 9, 2022
Merged

Conversation

tcvan0707
Copy link
Contributor

Issue This PR Addresses

Fixes issue #2960

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

This PR is going to set up Mermaid for our Docusaurus. The picture below is a sample to proof that Mermaid is working in our docs
image

Steps to test the PR

  • Change the current directory to src/docs: cd src/docs/
  • Run pnpm start
  • Go to localhost:4631 on the web browser

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

	* Configuration for Mermaid in Docusaurus
@gitpod-io
Copy link

gitpod-io bot commented Mar 9, 2022

@tpmai22 tpmai22 added this to the 2.8 Release milestone Mar 9, 2022
@tpmai22 tpmai22 added area: accessibility Making Telescope accessible for all kinds of users area: docusaurus Anything related to Docusaurus review: easy labels Mar 9, 2022
Copy link
Contributor

@cindyorangis cindyorangis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been waiting for this! You have no idea.

After following your steps, I added

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

to src/docs/docs/overview.md just to test it out and it worked!
2022-03-09 12_52_11-Window

I can finally unblock #2880 now

@tcvan0707
Copy link
Contributor Author

I've been waiting for this! You have no idea.

After following your steps, I added

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

to `src/docs/docs/overview.md` just to test it out and it worked! ![2022-03-09 12_52_11-Window](https://user-images.githubusercontent.com/36822198/157501472-b4e940b9-1a30-4295-8e48-1ff0e10bbfdd.png)

I can finally unblock #2880 now

If we want to make a graph, there is a keyword graph we have to specify, along with the TD is the direction where the graph will go, TD is Top Down I believe, I also tried LR (Left to Right) and RL (Right to Left). Hope this will help you!! 😊

@tpmai22
Copy link
Contributor

tpmai22 commented Mar 9, 2022

@tcvan0707 thank you for throwing those information in. That absolutely help me if I want to contribute in the future !

Copy link
Contributor

@menghif menghif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very useful!

Copy link
Contributor

@Kevan-Y Kevan-Y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice feature

@tcvan0707 tcvan0707 merged commit 46685e9 into Seneca-CDOT:master Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: accessibility Making Telescope accessible for all kinds of users area: docusaurus Anything related to Docusaurus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants