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 test repository to test your modified version of the action. - * Instead of using `uses: MarkBind/markbind-action@v2` in the workflow file, use `uses: yourGitHubName/markbind-action@yourBranch` to reference the unpublished version of the action that you are currently developing. + * Instead of using `uses: MarkBind/markbind-action@v2` in the workflow file, use `uses: yourGithubName/markbind-action@yourBranch` to reference the unpublished version of the action that you are currently developing. * e.g. `uses: tlylt/markbind-action@main` 1. Trigger the action as needed, check and validate the results in the action logs. -You can now submit PRs to improve MarkBind's Github actions! 🎉 +You can now submit PRs to improve MarkBind's GitHub actions! 🎉 ## Release Management -Based on the [Github Actions documentation](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions), we are using tags for release management. +Based on the [GitHub Actions documentation](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions), we are using tags for release management. > * Create and validate a release on a release branch (such as `release/v1`) before creating the release tag (for example, `v1.0.2`). > * Create a release using semantic versioning. For more information, see "[Creating releases](https://docs.github.com/en/articles/creating-releases)." diff --git a/docs/devGuide/projectManagement.md b/docs/devGuide/projectManagement.md index fc626b20be..195a67d2ec 100644 --- a/docs/devGuide/projectManagement.md +++ b/docs/devGuide/projectManagement.md @@ -39,7 +39,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http ### Merging -1. **Re-run the Github Actions `ci.yml` build** for the current PR. +1. **Re-run the GitHub Actions `ci.yml` build** for the current PR. @@ -237,7 +237,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http #653 Disable decamelize for anchor ID generation (#667, MarkBind/vue-strap#95) > Headings with PascalCase wordings now generate a different anchor ID - in order to be more compatible with anchor IDs generated by Github + in order to be more compatible with anchor IDs generated by GitHub Flavored Markdown. > > For example, if we have the following heading: @@ -301,7 +301,7 @@ This project follows the [all-contributors](https://allcontributors.org/) specif ### View all contributors -Besides the contributors list provided by Github, the list of all MarkBind contributors is available in `README.md`. +Besides the contributors list provided by GitHub, the list of all MarkBind contributors is available in `README.md`. The table shown in `README.md` is based on the entries from `.all-contributorsrc`. ### Add new contributors @@ -310,7 +310,7 @@ To simplify the process, use the all-contributors bot that has been installed in Example workflow: -1. A new contributor 'tlylt'(Github username) has opened a PR to committed code changes to the repository. +1. A new contributor 'tlylt'(GitHub username) has opened a PR to committed code changes to the repository. 1. A senior dev reviews and approves the PR. 1. The senior dev comments in that PR with the line "@all-contributors please add tlylt for code" to trigger an automatic PR that will apply relevant changes to include 'tlylt' in `.all-contributorsrc` and `README.md`. diff --git a/docs/devGuide/writingPlugins.md b/docs/devGuide/writingPlugins.md index 0cbf634a70..3645fc3a3b 100644 --- a/docs/devGuide/writingPlugins.md +++ b/docs/devGuide/writingPlugins.md @@ -46,7 +46,7 @@ Something referenced by a panel with a `src` attribute (``). 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..74d0becf05 100644 --- a/docs/userGuide/cliCommands.md +++ b/docs/userGuide/cliCommands.md @@ -21,7 +21,7 @@ Usage: markbind init|i [options] [root] init a markbind website project serve|s [options] [root] build then serve a website from a directory build|b [options] [root] [output] build a website - deploy|d [options] deploy the site to the repo's Github pages + deploy|d [options] deploy the site to the repo's GitHub pages ```
@@ -45,15 +45,15 @@ Usage: markbind **Options** :fas-cogs: * `-c`, `--convert`
- 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. + 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. * `markbind init ./myWebsite` : Initializes the site in `./myWebsite` directory. -* `markbind init --convert --template minimal`: Converts the Github wiki or `docs` folder in the current working directory into a minimal MarkBind website. +* `markbind init --convert --template minimal`: Converts the GitHub wiki or `docs` folder in the current working directory into a minimal MarkBind website.
@@ -174,7 +174,7 @@ The caveat is that not building all pages during the initial process, or not reb **Alias:** `markbind d` -**Description:** Deploys the site to the repo's Github pages by pushing everything in the generated site (default dir: `_site`) to the `gh-pages` branch of the current git working directory's remote repo. +**Description:** Deploys the site to the repo's GitHub pages by pushing everything in the generated site (default dir: `_site`) to the `gh-pages` branch of the current git working directory's remote repo. diff --git a/docs/userGuide/deployingTheSite.md b/docs/userGuide/deployingTheSite.md index 5f220c9f13..27edc0487a 100644 --- a/docs/userGuide/deployingTheSite.md +++ b/docs/userGuide/deployingTheSite.md @@ -34,15 +34,15 @@ 1. Use the [`markbind build -s ` command](cliCommands.html#build-command) to generate the site from source files. 1. Upload the site files to the Web server. The sections below explain how to automate this step if you are deploying to some online platforms. -## Deploying to Github Pages +## Deploying to GitHub Pages -**MarkBind can easily deploy a site to [Github pages](https://help.github.com/categories/github-pages-basics/)** if the project root directory is also a GitHub repo. +**MarkBind can easily deploy a site to [GitHub pages](https://help.github.com/categories/github-pages-basics/)** if the project root directory is also a GitHub repo. ### Using the `markbind deploy` command Running the **`markbind deploy`** command will deploy the most recent build of your site to the `gh-pages` branch of the repo `origin` and will be available. -Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on Github Pages for more details. +Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details. Your site will be online at `http://.github.io/` (e.g., http://se-edu.github.io/se-book). @@ -52,7 +52,7 @@ Your site will be online at `http://.github.io/` (e.g., http If you are deploying the site to GitHub pages, the `baseUrl` setting in the `site.json` should be set to the `"/"` for the links in the deployed site to work correctly. -{{ icon_example }} If you are using Github Pages to host your deployed website at repo `myorg/myproduct` (i.e., the website is published at `https://myorg.github.io/myproduct`), then your `baseUrl` should be `"/myproduct"`. +{{ icon_example }} If you are using GitHub Pages to host your deployed website at repo `myorg/myproduct` (i.e., the website is published at `https://myorg.github.io/myproduct`), then your `baseUrl` should be `"/myproduct"`. @@ -74,20 +74,20 @@ You can override the default deployment settings %%(e.g., repo/branch to deploy) ### Using CI Platforms **You can setup CI Platforms to automatically build and deploy your site on GitHub Pages every time your GitHub repo is updated.** - + -With the exception of Github Actions, a Github Personal Access Token with **repo** permissions is required for deploying your MarkBind site to Github Pages via CI tools. +With the exception of GitHub Actions, a GitHub Personal Access Token with **repo** permissions is required for deploying your MarkBind site to GitHub Pages via CI tools. -You may refer to Github's documentation on [how to generate a Github Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token). Ensure that you have enabled **repo** permissions as shown from the screenshot below. +You may refer to GitHub's documentation on [how to generate a GitHub Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token). Ensure that you have enabled **repo** permissions as shown from the screenshot below. Take note of the generated token - you will not be able to see it again once you navigate away from the page. - + -To instruct [Github Actions](https://docs.github.com/en/actions) to build and deploy the site when you push to the repository, add a Github Actions workflow file in your project repo at the location `/.github/workflows/deploy.yml` A sample workflow file is provided below: +To instruct [GitHub Actions](https://docs.github.com/en/actions) to build and deploy the site when you push to the repository, add a GitHub Actions workflow file in your project repo at the location `/.github/workflows/deploy.yml` A sample workflow file is provided below: ```yml name: Deploy MarkBind Site @@ -113,10 +113,10 @@ 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. +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`. @@ -139,7 +139,7 @@ jobs: Read the [action documentation](https://github.com/MarkBind/markbind-action#readme) to understand the various configuration options. -For more information on customizing your workflow file to fit your specific needs, you may refer to the [Github Action Docs](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions). +For more information on customizing your workflow file to fit your specific needs, you may refer to the [GitHub Action Docs](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions). @@ -181,7 +181,7 @@ Since May 2018, Travis CI has been [undergoing migration to `travis-ci.com`](htt **Configuring your repository in Travis CI** -1. [Add an environment variable in Travis CI](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) named `GITHUB_TOKEN`, with the value set to your [generated Github Personal Access Token](#generating-a-github-personal-access-token). ==Ensure that _Display value in the build log_ is set to _Off_.== +1. [Add an environment variable in Travis CI](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) named `GITHUB_TOKEN`, with the value set to your [generated GitHub Personal Access Token](#generating-a-github-personal-access-token). ==Ensure that _Display value in the build log_ is set to _Off_.== @@ -233,10 +233,10 @@ The `repo` value can be changed to your specific repository as desired. **Adding your repository to AppVeyor CI** -1. [Sign in to AppVeyor CI](https://ci.appveyor.com/login) using your Github Account. -1. Authorize AppVeyor App as Github App in the [account settings](https://ci.appveyor.com/authorizations) by clicking on the _Install AppVeyor App_ button. +1. [Sign in to AppVeyor CI](https://ci.appveyor.com/login) using your GitHub Account. +1. Authorize AppVeyor App as GitHub App in the [account settings](https://ci.appveyor.com/authorizations) by clicking on the _Install AppVeyor App_ button. - + 1. In the [projects directory](https://ci.appveyor.com/projects), click on the _New Project_ button. @@ -246,7 +246,7 @@ The `repo` value can be changed to your specific repository as desired. **Configuring your repository in AppVeyor CI** -1. Ensure that you have generated a [Github Personal Access token with **repo** permissions](#generating-a-github-personal-access-token). +1. Ensure that you have generated a [GitHub Personal Access token with **repo** permissions](#generating-a-github-personal-access-token). 1. Navigate to the project settings page of your repository in AppVeyor CI. 1. On the left menu, click on __Environment__. 1. Under the heading __Environment variables__, add a custom environment variable named `GITHUB_TOKEN`, with the value set to the personal access token that was generated in the first step. ==Ensure that you toggle variable encryption by clicking on the padlock.== @@ -254,7 +254,7 @@ The `repo` value can be changed to your specific repository as desired. 1. Remember to click __Save__ at the bottom of the page. -1. Add a `appveyor.yml`file at the root of your MarkBind site's repository to instruct AppVeyor CI to build and deploy the site to Github Pages when you push to your repository. More information on customizing `appveyor.yml` can be found in [AppVeyor documentation](https://www.appveyor.com/docs/appveyor-yml/). An example `appveyor.yml` file is given below: +1. Add a `appveyor.yml`file at the root of your MarkBind site's repository to instruct AppVeyor CI to build and deploy the site to GitHub Pages when you push to your repository. More information on customizing `appveyor.yml` can be found in [AppVeyor documentation](https://www.appveyor.com/docs/appveyor-yml/). An example `appveyor.yml` file is given below: ```yml environment: @@ -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. @@ -283,8 +283,8 @@ Commit and push `appveyor.yml` to your github repository. Thereafter, AppVeyor C **Adding your repository to Circle CI** -1. Ensure that you have generated a [Github Personal Access Token with **repo** permissions](#generating-a-github-personal-access-token). -1. Sign in to [Circle CI](https://circleci.com/) using your Github account. +1. Ensure that you have generated a [GitHub Personal Access Token with **repo** permissions](#generating-a-github-personal-access-token). +1. Sign in to [Circle CI](https://circleci.com/) using your GitHub account. 1. In the projects dashboard, click on the `Set Up Project` button beside the repo containing your MarkBind site. @@ -292,11 +292,11 @@ Commit and push `appveyor.yml` to your github repository. Thereafter, AppVeyor C **Configuring your repository in Circle CI** 1. Once you have set up your project, click on the `Project Settings` button. -2. On the left, click on the `Environment Variables` tab and add a custom Environment Variable, `GITHUB_TOKEN`, which contains the value of your Github Personal Access Token. +2. On the left, click on the `Environment Variables` tab and add a custom Environment Variable, `GITHUB_TOKEN`, which contains the value of your GitHub Personal Access Token. - + -3. Commit and push a `config.yml` file to the repo containing your MarkBind Site that instructs Circle CI to build and deploy your MarkBind site to Github Pages whenever you push to your repository. Ensure that the `config.yml` file is located in the `/.circleci/` directory. A sample `config.yml` file is shown below: +3. Commit and push a `config.yml` file to the repo containing your MarkBind Site that instructs Circle CI to build and deploy your MarkBind site to GitHub Pages whenever you push to your repository. Ensure that the `config.yml` file is located in the `/.circleci/` directory. A sample `config.yml` file is shown below: ```yml jobs: @@ -358,7 +358,7 @@ Now your site will be deployed on Netlify at the given address specified after d ## Previewing Pull Requests for MarkBind sites -**If you are hosting your MarkBind project on Github, you can setup PR previews in order to automatically build and deploy the modified MarkBind site based on the changes in the PR.** +**If you are hosting your MarkBind project on GitHub, you can setup PR previews in order to automatically build and deploy the modified MarkBind site based on the changes in the PR.** ### Previewing PRs using Netlify @@ -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 1a08d9f5df..f5263dfb54 100644 --- a/docs/userGuide/markBindSyntaxOverview.md +++ b/docs/userGuide/markBindSyntaxOverview.md @@ -40,7 +40,7 @@ MarkBind supports all basic Markdown syntax. #### {{ icon_check_blue }} Support for GFMD -MarkBind supports additional Markdown features provided by Github-Flavored Markdown (GFMD). +MarkBind supports additional Markdown features provided by GitHub-Flavored Markdown (GFMD). @@ -90,7 +90,7 @@ 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/5.1/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..5be59ec10c 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). @@ -203,7 +203,7 @@ The ignore pattern follows the [glob pattern used in .gitignore](https://git-scm #### **`deploy`** -**The settings for [auto-deployment to Github pages](deployingTheSite.html).** +**The settings for [auto-deployment to GitHub pages](deployingTheSite.html).** * **`message`** [Optional. Default: `"Site Update."`]
The commit message used for the deployment commit. 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/dropdowns.md b/docs/userGuide/syntax/dropdowns.md index f05731e1af..5017b3786c 100644 --- a/docs/userGuide/syntax/dropdowns.md +++ b/docs/userGuide/syntax/dropdowns.md @@ -27,10 +27,10 @@
  • Something else here
    • - +
    Left - +