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

Fix typos in docs #1902

Merged
merged 5 commits into from
Apr 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/devGuide/design/projectStructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The MarkBind project is developed in a <tooltip content="We follow a monorepo ap

* Functions and libraries used to parse and process MarkBind into usable output are stored in `src`. The architecture described in [Architecture](architecture.md) is contained here. A brief rundown of what it includes:

* Various key functionalities in processing MarkBind syntax into valid html output, stored in `html`. The other part of the content processing flow is found in `variables`, which manages site variables and facillitates the Nunjucks calls.
* Various key functionalities in processing MarkBind syntax into valid html output, stored in `html`. The other part of the content processing flow is found in `variables`, which manages site variables and facilitates the Nunjucks calls.

* `Page` files generate a single page of the site, and are managed by the `Site` instance. `Site` uses the Page model's interface to generate pages, and performs various other utility-like functions related to site generation such as copying of external assets into the output folder.

Expand All @@ -50,11 +50,11 @@ The MarkBind project is developed in a <tooltip content="We follow a monorepo ap

* [markdown-it](https://github.com/markdown-it/markdown-it), which does the Markdown parsing and rendering. There are also several customized markdown-it plugins used in MarkBind, which are located inside the `src/lib/markdown-it/` directory.

* Serveral markdown-it plugins are installed to enhance the existing Markdown syntax. They can be found in `src/package.json`. Some of them are patched in the `src/lib/markdown-it/patches/` directory to fit MarkBind's needs.
* Several markdown-it plugins are installed to enhance the existing Markdown syntax. They can be found in `src/package.json`. Some of them are patched in the `src/lib/markdown-it/patches/` directory to fit MarkBind's needs.

* Additionally, there are some markdown-it plugins in the `src/lib/markdown-it/plugins/` directory (either forked, modified or written to enhance existing functionalities).

* [htmlparser2](https://github.com/fb55/htmlparser2), a speedy and forgiving html parser which exposes a dom-like object structure to work on. To comply with the markdown spec, and our custom requirements, `src/patches/htmlparser2.js` patches various behaviours of this library.
* [htmlparser2](https://github.com/fb55/htmlparser2), a speedy and forgiving html parser which exposes a DOM-like object structure to work on. To comply with the markdown spec, and our custom requirements, `src/patches/htmlparser2.js` patches various behaviours of this library.

* [cheerio](https://cheerio.js.org/), which is a node.js equivalent of [jQuery](https://jquery.com/). Cheerio uses [htmlparser2](https://github.com/fb55/htmlparser2) to parse the html as well, hence our patches propagate here.

Expand All @@ -74,7 +74,7 @@ The CLI application uses and further builds on the interface exposed by the core

This package houses the various frontend assets used in the core package.

Some external assets included are Vue.js, jQuery, bootstrap bundles, and fontawesome bundles.
Some external assets included are Vue.js, jQuery, Bootstrap bundles, and FontAwesome bundles.

Internal bundles are also present, generated from setup scripts, custom stylesheets and the UI components library.

Expand Down
6 changes: 3 additions & 3 deletions docs/devGuide/githubActions/markbindAction.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ The source code is at [MarkBind/markbind-action](https://github.com/MarkBind/mar

## Testing the action
1. Include a workflow file in your <tooltip content="Which includes a sample MarkBind site">test repository</tooltip> 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.
jovyntls marked this conversation as resolved.
Show resolved Hide resolved
* 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)."
Expand Down
8 changes: 4 additions & 4 deletions docs/devGuide/projectManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<box type="info" seamless>

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/writingPlugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Something referenced by a panel with a `src` attribute (`<panel src="...">`).
external
</popover>.

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.
</box>

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:
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) (<tooltip content="GitHub Flavored Markdown">GFMD</tooltip>, 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) (<tooltip content="GitHub Flavored Markdown">GFMD</tooltip>, 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:

Expand All @@ -30,7 +30,7 @@ MarkBind extensions to Markdown | `==highlighted text==`<br>`%%grey text%%`<br>`

<panel type="seamless" header="%%More examples of generating static content%%" >

An example that uses GFMD synatx for task lists:
An example that uses GFMD syntax for task lists:

<table>
<tr>
Expand Down
10 changes: 5 additions & 5 deletions docs/userGuide/cliCommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Usage: markbind <command>
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
```
<hr><!-- ========================================================================== -->
<div id="markbind-init">
Expand All @@ -45,15 +45,15 @@ Usage: markbind <command>
**Options** :fas-cogs:

* `-c`, `--convert`<br>
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` <br>
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.

</panel>
</div>
Expand Down Expand Up @@ -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.

<panel header="**Options** :fas-cogs:" type="minimal" expanded>

Expand Down
Loading