From 3dbdeb60209313f289f71cfc4e0596bb3f225d79 Mon Sep 17 00:00:00 2001 From: Jovyn Tan Date: Wed, 13 Apr 2022 00:04:54 +0800 Subject: [PATCH 1/4] Fix typos --- docs/devGuide/design/projectStructure.md | 8 ++++---- docs/devGuide/writingPlugins.md | 2 +- docs/index.md | 4 ++-- docs/userGuide/cliCommands.md | 2 +- docs/userGuide/deployingTheSite.md | 8 ++++---- docs/userGuide/markBindSyntaxOverview.md | 4 ++-- docs/userGuide/siteJsonFile.md | 2 +- docs/userGuide/syntax/boxes.md | 2 +- docs/userGuide/syntax/code.md | 2 +- docs/userGuide/syntax/dates.md | 2 +- docs/userGuide/syntax/embeds.md | 6 +++--- docs/userGuide/syntax/extra/quiz.md | 2 +- docs/userGuide/syntax/footnotes.md | 4 ++-- docs/userGuide/syntax/frontmatter.md | 2 +- docs/userGuide/syntax/horizontalrules.md | 4 ++-- docs/userGuide/syntax/navBars.md | 4 ++-- docs/userGuide/syntax/panels.md | 4 ++-- docs/userGuide/syntax/popovers.md | 2 +- docs/userGuide/syntax/variables.md | 6 +++--- docs/userGuide/tipsAndTricks.md | 8 ++++---- docs/userGuide/usingHtmlJavaScriptCss.md | 2 +- 21 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/devGuide/design/projectStructure.md b/docs/devGuide/design/projectStructure.md index dbe85e7c68..fadf7aa6a9 100644 --- a/docs/devGuide/design/projectStructure.md +++ b/docs/devGuide/design/projectStructure.md @@ -34,7 +34,7 @@ The MarkBind project is developed in a `). external . -That is, the dom tree being processed during `processNode` and the content passed into `postRender` will belong to either one of these types of files. +That is, the DOM tree being processed during `processNode` and the content passed into `postRender` will belong to either one of these types of files. An example of a plugin is shown below. The plugin shows two ways of appending a paragraph of text to a specific `div` in the Markdown files: diff --git a/docs/index.md b/docs/index.md index 6ff1b63823..2f7e205299 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ Optimized for creating text-heavy websites %%e.g., eLearning websites, online in #### {{ icon_check_blue }} Simple syntax. Dynamic content. -MarkBind source files can be as simple as basic Markdown, but you can also [**use a mix of several popular syntax schemes**](userGuide/markBindSyntaxOverview.html) (GFMD, BootStrap, NunJucks, etc. as well as MarkBind's own custom syntax) to create more dynamic content that you cannot normally get from a typical markdown-to-html site generator. +MarkBind source files can be as simple as basic Markdown, but you can also [**use a mix of several popular syntax schemes**](userGuide/markBindSyntaxOverview.html) (GFMD, Bootstrap, Nunjucks, etc. as well as MarkBind's own custom syntax) to create more dynamic content that you cannot normally get from a typical markdown-to-html site generator. Here are some simple text-formatting examples: @@ -30,7 +30,7 @@ MarkBind extensions to Markdown | `==highlighted text==`
`%%grey text%%`
` -An example that uses GFMD synatx for task lists: +An example that uses GFMD syntax for task lists: diff --git a/docs/userGuide/cliCommands.md b/docs/userGuide/cliCommands.md index b8a6455557..65d5a28b2a 100644 --- a/docs/userGuide/cliCommands.md +++ b/docs/userGuide/cliCommands.md @@ -48,7 +48,7 @@ Usage: markbind Convert an existing GitHub wiki or `docs` folder into a MarkBind website. See [Converting an existing Github project]({{ baseUrl }}/userGuide/markBindInTheProjectWorkflow.html#converting-existing-project-documentation-wiki) for more information. * `-t`, `--template`
- When initialising markbind, change the template that you start with. See [templates](templates.html). + When initialising MarkBind, change the template that you start with. See [templates](templates.html). {{ icon_examples }} * `markbind init` : Initializes the site in the current working directory. diff --git a/docs/userGuide/deployingTheSite.md b/docs/userGuide/deployingTheSite.md index 5f220c9f13..8060e33902 100644 --- a/docs/userGuide/deployingTheSite.md +++ b/docs/userGuide/deployingTheSite.md @@ -116,7 +116,7 @@ jobs: The sample `deploy.yml` workflow above uses the [default Github Token secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) that is generated automatically for each Github Actions workflow. You may also use a [Github Personal Access Token](#generating-a-github-personal-access-token) in place of the default Github Token. -Once you have created the file, commit and push the file to your repo. Github Actions should start to build and deploy your markbind site. You can verify this by visiting `www.github.com///actions`. +Once you have created the file, commit and push the file to your repo. Github Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com///actions`. @@ -275,7 +275,7 @@ The `repo` value can be changed to your specific repository as desired. build: off ``` -Commit and push `appveyor.yml` to your github repository. Thereafter, AppVeyor CI should begin to run the build script. You are able to view the current build status by clicking on your repository in the [AppVeyor projects page](https://ci.appveyor.com/projects). Once the build succeeds, you should be able to view your MarkBind site, after a few seconds, at `http://.github.io/` e.g., http://se-edu.github.io/se-book. +Commit and push `appveyor.yml` to your Github repository. Thereafter, AppVeyor CI should begin to run the build script. You are able to view the current build status by clicking on your repository in the [AppVeyor projects page](https://ci.appveyor.com/projects). Once the build succeeds, you should be able to view your MarkBind site, after a few seconds, at `http://.github.io/` e.g., http://se-edu.github.io/se-book. @@ -398,7 +398,7 @@ You may also preview PRs using [Surge](https://surge.sh/), which is an NPM packa -1. Commit and push the following 2 files into your markbind site repo, in the directory `/.github/workflows/`. +1. Commit and push the following 2 files into your MarkBind site repo, in the directory `/.github/workflows/`. @@ -453,7 +453,7 @@ jobs: In **line 34** of the workflow code below, you are required to update the `PR_URL` according to your needs. We recommend just changing the section `` to something that can easily identify your MarkBind project repository. -For example, if the name of your repository is `MyRepo`, and it is managed under an organization `MyOrganization`, you could replace `` to `myorganization-myrepo` and your PR Preview will be deployed at the following url: `https://pr--myorganization-myrepo.surge.sh`. +For example, if the name of your repository is `MyRepo`, and it is managed under an organization `MyOrganization`, you could replace `` to `myorganization-myrepo` and your PR Preview will be deployed at the following URL: `https://pr--myorganization-myrepo.surge.sh`. Advanced users may completely replace the default `PR_URL`. ==**It is recommended to test your workflow code on a test repo before using it for your MarkBind project repo.**== diff --git a/docs/userGuide/markBindSyntaxOverview.md b/docs/userGuide/markBindSyntaxOverview.md index 0677fdb226..7d3146b794 100644 --- a/docs/userGuide/markBindSyntaxOverview.md +++ b/docs/userGuide/markBindSyntaxOverview.md @@ -90,9 +90,9 @@ More info: -#### {{ icon_check_blue }} MarkBind Vue components and BootStrap +#### {{ icon_check_blue }} MarkBind Vue components and Bootstrap -MarkBind has several core Vue.js components built on the popular [BootStrap](https://getbootstrap.com/docs/4.2/getting-started/introduction/) framework. Much of Bootstrap's features are supported in and out of these components as well. +MarkBind has several core Vue.js components built on the popular [Bootstrap](https://getbootstrap.com/docs/4.2/getting-started/introduction/) framework. Much of Bootstrap's features are supported in and out of these components as well. diff --git a/docs/userGuide/siteJsonFile.md b/docs/userGuide/siteJsonFile.md index 85159a2f89..30867095a9 100644 --- a/docs/userGuide/siteJsonFile.md +++ b/docs/userGuide/siteJsonFile.md @@ -78,7 +78,7 @@ Here is a typical `site.json` file: #### **`baseUrl`** -**The base url relative to your domain.** Default: `""`(empty). +**The base URL relative to your domain.** Default: `""`(empty). diff --git a/docs/userGuide/syntax/boxes.md b/docs/userGuide/syntax/boxes.md index c8b8597445..ff2c95d2a7 100644 --- a/docs/userGuide/syntax/boxes.md +++ b/docs/userGuide/syntax/boxes.md @@ -229,7 +229,7 @@ theme | `String` | `''` | Supports: `primary`, `secondary`, `success`, `danger`, light | `Boolean` | `false` | Uses a light color scheme for the box. seamless | `Boolean` | `false` | Uses a seamless style for the box. If `light` is specified, this style will not be activated. no-border | `Boolean` | `false` | Removes border, except if styled by `border-color` or `border-left-color`. -no-backgound | `Boolean` | `false` | Removes background, except if styled by `backgound-color` option. +no-background | `Boolean` | `false` | Removes background, except if styled by `background-color` option. no-icon | `Boolean` | `false` | Removes icon, except if icon is displayed via `icon` option. diff --git a/docs/userGuide/syntax/code.md b/docs/userGuide/syntax/code.md index 4561f2220b..959af92be7 100644 --- a/docs/userGuide/syntax/code.md +++ b/docs/userGuide/syntax/code.md @@ -214,7 +214,7 @@ MarkBind can apply syntax-coloring on inline code too. -Consider the xml code `goo`{.xml},
+Consider the XML code `goo`{.xml},
or the java code `public static void main(String[] args)`{.java}. diff --git a/docs/userGuide/syntax/dates.md b/docs/userGuide/syntax/dates.md index 1d7273464d..32fa892355 100644 --- a/docs/userGuide/syntax/dates.md +++ b/docs/userGuide/syntax/dates.md @@ -58,7 +58,7 @@ Default format: `"ddd D MMM"` e.g. Fri 6 Mar Token | Output -- | - +--- | --- D | 1 Do | 1st DD | 01 diff --git a/docs/userGuide/syntax/embeds.md b/docs/userGuide/syntax/embeds.md index 5888ab2508..0b0fa32a8f 100644 --- a/docs/userGuide/syntax/embeds.md +++ b/docs/userGuide/syntax/embeds.md @@ -2,7 +2,7 @@ **There are easy ways to embed media content such as YouTube videos and PowerPoint slides**. -###### Embedding Youtube Videos +###### Embedding YouTube Videos Here are three ways of embedding YouTube videos and one example of how it will look in the page. @@ -24,7 +24,7 @@ Here are three ways of embedding YouTube videos and one example of how it will l More media blocks, embedding services and additional options can be found in [Markdown-it documentation](https://github.com/rotorz/markdown-it-block-embed). -###### Embedding Powerpoint Slides (using the embed url from Powerpoint online) +###### Embedding PowerPoint Slides (using the embed URL from PowerPoint online) Here is an example of embedding a PowerPoint slide deck: @@ -56,4 +56,4 @@ Embedded slide deck: @[powerpoint](https://onedrive.live.com/embed?cid=A5AF047C4CAD67AB&resid=A5AF047C4CAD67AB%212070&authkey=&em=2) - \ No newline at end of file + diff --git a/docs/userGuide/syntax/extra/quiz.md b/docs/userGuide/syntax/extra/quiz.md index ee82ab4c98..e605d1ebd4 100644 --- a/docs/userGuide/syntax/extra/quiz.md +++ b/docs/userGuide/syntax/extra/quiz.md @@ -1,5 +1,5 @@ - Q1. Name all different types of voliatile memory that exists inside a typical household computer system. + Q1. Name all different types of volatile memory that exists inside a typical household computer system.
CPU cache and RAM
 diff --git a/docs/userGuide/syntax/footnotes.md b/docs/userGuide/syntax/footnotes.md index 65cf627bba..14a52beae5 100644 --- a/docs/userGuide/syntax/footnotes.md +++ b/docs/userGuide/syntax/footnotes.md @@ -17,7 +17,7 @@ belong to the previous footnote. **Inline footnotes:** -Here is an inline note.^[Inlines notes are easier to write, since +Here is an inline note.^[Inline notes are easier to write, since you don't have to pick an identifier and move down to type the note.] @@ -27,7 +27,7 @@ note.] -Normal footnotes won't work when used inside the attributes of markbind components! +Normal footnotes won't work when used inside the attributes of MarkBind components!
For example, it won't work in the `header` attribute of [panels](../components/presentation.html#panels). diff --git a/docs/userGuide/syntax/frontmatter.md b/docs/userGuide/syntax/frontmatter.md index c65a086758..81b0c8ca88 100644 --- a/docs/userGuide/syntax/frontmatter.md +++ b/docs/userGuide/syntax/frontmatter.md @@ -20,7 +20,7 @@ -Should you need more expressive formatting, or encounter any issues when formatting the frontmatter, note that the frontmatter follows the [yaml](https://yaml.org/refcard.html) spec. +Should you need more expressive formatting, or encounter any issues when formatting the frontmatter, note that the frontmatter follows the [YAML](https://yaml.org/refcard.html) spec. **Page properties:** diff --git a/docs/userGuide/syntax/horizontalrules.md b/docs/userGuide/syntax/horizontalrules.md index 886f8e5816..6c75b80405 100644 --- a/docs/userGuide/syntax/horizontalrules.md +++ b/docs/userGuide/syntax/horizontalrules.md @@ -54,7 +54,7 @@ Available size classes: -Available color classes (use any of the available BootStrap border color classes): +Available color classes (use any of the available Bootstrap border color classes): - border-info - border-primary - etc @@ -76,7 +76,7 @@ Available color classes (use any of the available BootStrap border color classes -Add a comibnation of the above classes to further customize the style of a horizontal line. +Add a combination of the above classes to further customize the style of a horizontal line. markdown diff --git a/docs/userGuide/syntax/navBars.md b/docs/userGuide/syntax/navBars.md index 97cacde8bb..131bbb58eb 100644 --- a/docs/userGuide/syntax/navBars.md +++ b/docs/userGuide/syntax/navBars.md @@ -202,7 +202,7 @@ Component | Description You may also wish to style your navigation content differently on mobile view. By default, MarkBind already provides some reasonable overrides for smaller screens, applied over any styles you might have for the mobile navigation content identified above. -```css {heading="Css class attached to the root navigation element"} +```css {heading="CSS class attached to the root navigation element"} .mb-mobile-nav { display: block !important; margin: 0 !important; @@ -228,5 +228,5 @@ If you require greater customisation, you may simply compose the respective sele -Refer to the [layouts](../tweakingThePageStructure.md) section to find out how to add custom css files to a page! +Refer to the [layouts](../tweakingThePageStructure.md) section to find out how to add custom CSS files to a page! diff --git a/docs/userGuide/syntax/panels.md b/docs/userGuide/syntax/panels.md index 2ef955cbec..9117b6acbd 100644 --- a/docs/userGuide/syntax/panels.md +++ b/docs/userGuide/syntax/panels.md @@ -202,9 +202,9 @@ peek | `Boolean` | `false` | Whether to show part of the content when the Panel no-close | `Boolean` | `false` | Whether to show the close button. no-switch | `Boolean` | `false` | Whether to show the expand switch. bottom-switch | `Boolean` | `true` | Whether to show an expand switch at the bottom of the panel. Independent of no-switch. -popup-url | `String` | | The url that the popup window will navigate to. The url can be absolute or relative. +popup-url | `String` | | The URL that the popup window will navigate to. The URL can be absolute or relative. preload | `Boolean` | `false` | Whether the content is loaded immediately from `src`. -src | `String` | | The url to the remote page to be loaded as the content of the panel. +src | `String` | | The URL to the remote page to be loaded as the content of the panel. type | `String` | `light` | The type or color scheme of the panel (single).
Supports: `light`, `dark`, `primary`, `secondary`, `info`, `success`, `warning`, `danger`, `seamless`, `minimal`.
diff --git a/docs/userGuide/syntax/popovers.md b/docs/userGuide/syntax/popovers.md index 657d3374af..d7be7472c7 100644 --- a/docs/userGuide/syntax/popovers.md +++ b/docs/userGuide/syntax/popovers.md @@ -96,7 +96,7 @@ This is the same trigger as last one. | trigger | `String` | `hover focus` | How the Popover is triggered.
Supports: `click`, `focus`, `hover`, or any space-separated combination of these. | | header{{slot_info_trigger}} | `String` | `''` | Popover header, supports MarkDown text. | | content{{slot_info_trigger}} | `String` | `''` | Popover content, supports MarkDown text. | -| src | `String` | | The url to the remote page to be loaded as the content of the popover.
Both `.md` and `.html` are accepted. | +| src | `String` | | The URL to the remote page to be loaded as the content of the popover.
Both `.md` and `.html` are accepted. | | placement | `String` | `top` | How to position the Popover.
Supports: `top`, `left`, `right`, `bottom`. | diff --git a/docs/userGuide/syntax/variables.md b/docs/userGuide/syntax/variables.md index 4840fe8a27..49a7045e62 100644 --- a/docs/userGuide/syntax/variables.md +++ b/docs/userGuide/syntax/variables.md @@ -9,7 +9,7 @@ **Nunjucks [variables](https://mozilla.github.io/nunjucks/templating.html#set) are ideal for reusing small bits of code** in multiple places; you can define a variable to represent the code bit in question and reuse it anywhere in the site by referring to the variable instead of duplicating the code bit.
-MarkBind does not aim to alter the already robust variable features of nunjucks, but provides several extensions to it. +MarkBind does not aim to alter the already robust variable features of Nunjucks, but provides several extensions to it. ### Global Variables @@ -89,9 +89,9 @@ Student Number | Score | Rank ``` {% endraw %} - + -```json {heading="Json File"} +```json {heading="JSON File"} {% include "userGuide/syntax/extra/scoreboard.json" %} ``` diff --git a/docs/userGuide/tipsAndTricks.md b/docs/userGuide/tipsAndTricks.md index 7eae6e8c8d..f1eb4271cf 100644 --- a/docs/userGuide/tipsAndTricks.md +++ b/docs/userGuide/tipsAndTricks.md @@ -40,7 +40,7 @@ the `v-pre` attribute using markdown-it-attrs or as a html attribute. -This isn't necessary for `` elements, markdown code fences and inline code though, which markbind automatically +This isn't necessary for `` elements, markdown code fences and inline code though, which MarkBind automatically adds `v-pre` for. However, this does not change the need for `{% raw %}{% endraw %}`. Meaning, you can still use variables within your code! @@ -85,7 +85,7 @@ When you use links or triggers, you may encounter a situation where an unwanted When the [default CI configuration for deployment](deployingTheSite.html#using-ci-platforms) is used, the latest version of MarkBind will be used in the CI workflows. This may be a later version of MarkBind than the one you use locally. -* If you want to specify a version of MarkBind (eg. `v1.6.3`), you have to modify the step where `markbind-cli` is being installed to `npm i -g markbind-cli@v1.6.3`. For example, for Travis-CI, you can modifiy the `install` step in `.travis.yml` as follows: +* If you want to specify a version of MarkBind (eg. `v1.6.3`), you have to modify the step where `markbind-cli` is being installed to `npm i -g markbind-cli@v1.6.3`. For example, for Travis-CI, you can modify the `install` step in `.travis.yml` as follows: ```yaml install: @@ -104,7 +104,7 @@ Here are the steps to set up Netlify to use a specific version of MarkBind. 1. Navigate to the root directory of your site. 1. Run `npm init` which will create `package.json` and `package.lock.json` -1. Run `npm install markbind-cli@1.6.3 --save` to install markbind as a dependency (using v1.6.3 as an example) +1. Run `npm install markbind-cli@1.6.3 --save` to install MarkBind as a dependency (using v1.6.3 as an example) 1. Create / Update `.gitignore` file in the root directory and add: ``` node_modules @@ -157,7 +157,7 @@ to the component. The following examples show how to do this. ... - The "ml-3" is arbitarily chosen i.e "ml-0" to "ml-5" are all possible values. + The "ml-3" is arbitrarily chosen i.e "ml-0" to "ml-5" are all possible values. ... diff --git a/docs/userGuide/usingHtmlJavaScriptCss.md b/docs/userGuide/usingHtmlJavaScriptCss.md index f31672e7c2..599d90b8f5 100644 --- a/docs/userGuide/usingHtmlJavaScriptCss.md +++ b/docs/userGuide/usingHtmlJavaScriptCss.md @@ -122,7 +122,7 @@ const myChart = new Chart(ctx, {