From 8b357459285fbdbacf2fe89d24899ee095ce8ce9 Mon Sep 17 00:00:00 2001 From: AlwinW <16846521+AlwinW@users.noreply.github.com> Date: Sat, 23 Oct 2021 22:57:24 +1100 Subject: [PATCH] Corrected typos in documentation --- CONTRIBUTING.md | 2 +- docs/Configuration.md | 4 ++-- docs/README.md | 2 +- docs/Setup.md | 24 +++++++++---------- docs/development.md | 2 +- docs/gantt.md | 2 +- docs/integrations.md | 4 ++-- docs/n00b-syntaxReference.md | 2 +- docs/requirementDiagram.md | 4 ++-- docs/usage.md | 2 +- src/defaultConfig.js | 16 ++++++------- .../flowchart/parser/flow-style.spec.js | 6 ++--- src/diagrams/git/gitGraphParser.spec | 6 ++--- 13 files changed, 38 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d719b9523..6d9bc67b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Here are a few things to know to get you started on the right path. We make all changes via pull requests. As we have many pull requests from developers new to mermaid, the current approach is to have *knsv, Knut Sveidqvist* as a main reviewer of changes and merging pull requests. More precisely like this: * Large changes reviewed by knsv or other developer asked to review by knsv -* Smaller low-risk changes like dependecies, documentation etc can be merged by active collaborators +* Smaller low-risk changes like dependencies, documentation etc can be merged by active collaborators * documentation (updates to the docs folder is also allowed via direct commits) To commit code, create a branch, let it start with the type like feature or bug followed by the issue number for reference and some describing text. diff --git a/docs/Configuration.md b/docs/Configuration.md index a67e3a722..543bee876 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -2,7 +2,7 @@ Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid. -This section will introduce the different methods of configuring of the behaviors and apperances of Mermaid Diagrams. +This section will introduce the different methods of configuring of the behaviors and appearances of Mermaid Diagrams. The Following are the most commonly used methods, and are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods. ## Configuration Section in the [Live Editor](./Live-Editor.md). @@ -13,7 +13,7 @@ The Following are the most commonly used methods, and are all tied to Mermaid [D ## [Directives](./directives.md), -allows the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. you can pass a directive alongside your defintion inside `%%{ }%%`, either above or below your diagram defintion. +allows the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. you can pass a directive alongside your definition inside `%%{ }%%`, either above or below your diagram definition. ## Theme Creation: An application of using Directives to change [Themes](./theming.md). `Theme` is an value within mermaid's configuration that dictates the color scheme for diagrams. diff --git a/docs/README.md b/docs/README.md index ab5239014..543c24ea0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -199,7 +199,7 @@ To Deploy Mermaid: ``` -**Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"`. From these tags mermaid will try to read the diagram/chart definitons and render them into svg charts.** +**Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"`. From these tags mermaid will try to read the diagram/chart definitions and render them into svg charts.** **Examples can be found at** [Other examples](/examples) diff --git a/docs/Setup.md b/docs/Setup.md index 8d0b1778d..e7b2f8484 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -70,7 +70,7 @@ theme , the CSS style sheet | Parameter | Description | Type | Required | Values | | ---------- | ------------------------------------------------------ | ------ | -------- | --------------------------- | -| fontFamily | specifies the font to be used in the rendered diagrams | string | Required | Any Posiable CSS FontFamily | +| fontFamily | specifies the font to be used in the rendered diagrams | string | Required | Any Possible CSS FontFamily | **Notes:** Default value: '"trebuchet ms", verdana, arial, sans-serif;'. @@ -103,9 +103,9 @@ Default value: '"trebuchet ms", verdana, arial, sans-serif;'. ## startOnLoad -| Parameter | Description | Type | Required | Values | -| ----------- | --------------------------------------------- | ------- | -------- | ----------- | -| startOnLoad | Dictates whether mermaind starts on Page load | boolean | Required | true, false | +| Parameter | Description | Type | Required | Values | +| ----------- | -------------------------------------------- | ------- | -------- | ----------- | +| startOnLoad | Dictates whether mermaid starts on Page load | boolean | Required | true, false | **Notes:** Default value: true @@ -204,7 +204,7 @@ Default value 50 **Notes:** -Default Vaue: 'basis' +Default Value: 'basis' ### useMaxWidth @@ -411,7 +411,7 @@ Default value: false | Parameter | Description | Type | Required | Values | | --------------- | ---------------------------------------------------- | ------ | -------- | --------------------------- | -| actorFontFamily | This sets the font family of the actor's description | string | Required | Any Posiable CSS FontFamily | +| actorFontFamily | This sets the font family of the actor's description | string | Required | Any Possible CSS FontFamily | **Notes:** Default value: "'Open-Sans", "sans-serif"' @@ -436,7 +436,7 @@ Default value: 14 | Parameter | Description | Type | Required | Values | | -------------- | -------------------------------------------------- | ------ | -------- | --------------------------- | -| noteFontFamily | This sets the font family of actor-attached notes. | string | Required | Any Posiable CSS FontFamily | +| noteFontFamily | This sets the font family of actor-attached notes. | string | Required | Any Possible CSS FontFamily | **Notes:** Default value: ''"trebuchet ms", verdana, arial, sans-serif' @@ -470,7 +470,7 @@ Default value: 16 | Parameter | Description | Type | Required | Values | | ----------------- | ------------------------------------------- | ------ | -------- | --------------------------- | -| messageFontFamily | This sets the font family of actor messages | string | Required | Any Posiable CSS FontFamily | +| messageFontFamily | This sets the font family of actor messages | string | Required | Any Possible CSS FontFamily | **Notes:** Default value: '"trebuchet ms", verdana, arial, sans-serif' @@ -590,9 +590,9 @@ Default value: 11 ### sectionFontSize -| Parameter | Description | Type | Required | Values | -| --------------- | --------------------- | ------- | -------- | ------------------ | -| sectionFontSize | Font size for secions | Integer | Required | Any Positive Value | +| Parameter | Description | Type | Required | Values | +| --------------- | ---------------------- | ------- | -------- | ------------------ | +| sectionFontSize | Font size for sections | Integer | Required | Any Positive Value | **Notes:** Default value: 11 @@ -879,7 +879,7 @@ Default value: 'TB' | Parameter | Description | Type | Required | Values | | -------------- | ---------------------------------- | ------- | -------- | ------------------ | -| minEntityWidth | The mimimum width of an entity box | Integer | Required | Any Positive Value | +| minEntityWidth | The minimum width of an entity box | Integer | Required | Any Positive Value | **Notes:** Expressed in pixels. diff --git a/docs/development.md b/docs/development.md index 22b110e28..899ef9dee 100644 --- a/docs/development.md +++ b/docs/development.md @@ -25,7 +25,7 @@ This means that **you should branch off your pull request from develop** and dir We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein *knsv, Knut Sveidqvist* is the primary reviewer of changes and merging pull requests. The process is as follows: * Large changes reviewed by knsv or other developer asked to review by knsv -* Smaller, low-risk changes like dependecies, documentation, etc. can be merged by active collaborators +* Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators * Documentation (we encourage updates to the docs folder; you can submit them via direct commits) When you commit code, create a branch with the following naming convention: diff --git a/docs/gantt.md b/docs/gantt.md index 0467d2b5f..7f248d98f 100644 --- a/docs/gantt.md +++ b/docs/gantt.md @@ -133,7 +133,7 @@ To do so, start a line with the `section` keyword and give it a name. (Note that ### Milestones -You can add milestones to the diagrams. Milestones differ from tasks as they represent a signle instant in time and are identifiedd by the keyword `milestone`. Below is an example on how to use milestones. As you may notice, the exact location of the milestone is determined by the initial date for the milestone and the "duration" of the task this way: *initial date*+*duration*/2. +You can add milestones to the diagrams. Milestones differ from tasks as they represent a single instant in time and are identified by the keyword `milestone`. Below is an example on how to use milestones. As you may notice, the exact location of the milestone is determined by the initial date for the milestone and the "duration" of the task this way: *initial date*+*duration*/2. ``` gantt diff --git a/docs/integrations.md b/docs/integrations.md index e64887247..d20668e8d 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -12,7 +12,7 @@ They also serve as proof of concept, for the variety of things that can be built - [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) - [Joplin](https://joplinapp.org) (**Native support**) - [GitHub](https://github.com) - - [Github action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action) + - [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action) - [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator) - [GitBook](http://gitbook.com) - [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid) @@ -37,7 +37,7 @@ They also serve as proof of concept, for the variety of things that can be built - [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md) - [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/) - [Hexo](https://hexo.io) - - [hexo-filter-mermid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams) + - [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams) - [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid) - [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams) diff --git a/docs/n00b-syntaxReference.md b/docs/n00b-syntaxReference.md index d9a3f26df..fdffac01b 100644 --- a/docs/n00b-syntaxReference.md +++ b/docs/n00b-syntaxReference.md @@ -72,7 +72,7 @@ Used when Mermaid is called via an API, or through a `