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.

Sign up for GitHub

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

Docs button - fix paths to respective page on Mermaid JS docs site #1329

Closed
wants to merge 2 commits into from
Closed

Docs button - fix paths to respective page on Mermaid JS docs site #1329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
269c4e4
fix docs paths
huynhicode Oct 30, 2023
ff88a24
update tests
huynhicode Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions cypress/e2e/docMap.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ describe('Editor docs tests', () => {

it('Test to see if the correct URL loads when changing from one diagram to other', () => {
cy.contains('Flow').click();
cy.get(`[data-cy=docs][href$="/#/flowchart"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/flowchart"]`).should('exist');

cy.contains('Config').click();
cy.get(`[data-cy=docs][href$="/#/flowchart?id=configuration"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/flowchart?id=configuration"]`).should('exist');

cy.contains('Sequence').click();
cy.get(`[data-cy=docs][href$="/#/sequenceDiagram?id=configuration"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/sequenceDiagram?id=configuration"]`).should('exist');

cy.contains('Code').click();
cy.get(`[data-cy=docs][href$="/#/sequenceDiagram"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/sequenceDiagram"]`).should('exist');
});

it("Test to check URLs for a case where config URL doesn't exist", () => {
cy.contains('State').click();
cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/stateDiagram"]`).should('exist');

cy.contains('Config').click();
cy.get(`[data-cy=docs][href$="/#/stateDiagram"]`).should('exist');
cy.get(`[data-cy=docs][href$="/syntax/stateDiagram"]`).should('exist');
});
});
57 changes: 32 additions & 25 deletions src/routes/edit/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,42 +16,49 @@
const MCBaseURL = dev ? 'http://localhost:5174' : 'https://mermaidchart.com';
const docURLBase = 'https://mermaid-js.github.io/mermaid';
const docMap: DocumentationConfig = {
graph: {
code: '/#/flowchart',
config: '/#/flowchart?id=configuration'
classDiagram: {
code: '/syntax/classDiagram',
config: '/syntax/classDiagram#configuration'
},
erDiagram: {
code: '/syntax/entityRelationshipDiagram'
},
flowchart: {
code: '/#/flowchart',
config: '/#/flowchart?id=configuration'
code: '/syntax/flowchart',
config: '/syntax/flowchart#configuration'
},
sequenceDiagram: {
code: '/#/sequenceDiagram',
config: '/#/sequenceDiagram?id=configuration'
gantt: {
code: '/syntax/gantt',
config: '/syntax/gantt#configuration'
},
classDiagram: {
code: '/#/classDiagram',
config: '/#/classDiagram?id=configuration'
gitGraph: {
code: '/syntax/gitgraph',
config: '/syntax/gitgraph#gitgraph-specific-configuration-options'
},
'stateDiagram-v2': {
code: '/#/stateDiagram'
graph: {
code: '/syntax/flowchart',
config: '/syntax/flowchart#configuration'
},
gantt: {
code: '/#/gantt',
config: '/#/gantt?id=configuration'
journey: {
code: '/syntax/userJourney'
},
mindmap: {
code: '/syntax/mindmap'
},
pie: {
code: '/#/pie'
code: '/syntax/pie',
config: '/syntax/pie#configuration'
},
erDiagram: {
code: '/#/entityRelationshipDiagram',
config: '/#/entityRelationshipDiagram?id=styling'
quadrantChart: {
code: '/syntax/quadrantChart',
config: '/syntax/quadrantChart#chart-configurations'
},
journey: {
code: '/#/user-journey'
sequenceDiagram: {
code: '/syntax/sequenceDiagram',
config: '/syntax/sequenceDiagram#configuration'
},
gitGraph: {
code: '/#/gitgraph',
config: '/#/gitgraph?id=gitgraph-specific-configuration-options'
'stateDiagram-v2': {
code: '/syntax/stateDiagram'
}
};
let docURL = docURLBase;
Expand Down
Loading