Skip to content

Commit 58ae594

Browse files
authored
Fix typos found with cSpell (#1621)
Fix typos found wtih cSpell
1 parent 8aae14b commit 58ae594

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The private parameter has removed, use a access
8282

8383
### Bug Fixes
8484

85-
* [@see](https://github.com/see) tags incorrectly formatted in markdown ouput fixed [#1337](https://github.com/documentationjs/documentation/issues/1337) ([5d8d450](https://github.com/documentationjs/documentation/commit/5d8d4504d52a5bb0a0432bf399bbd82d9e5ea7fc))
85+
* [@see](https://github.com/see) tags incorrectly formatted in markdown output fixed [#1337](https://github.com/documentationjs/documentation/issues/1337) ([5d8d450](https://github.com/documentationjs/documentation/commit/5d8d4504d52a5bb0a0432bf399bbd82d9e5ea7fc))
8686

8787
### [13.2.1](https://github.com/documentationjs/documentation/compare/v13.2.0...v13.2.1) (2021-04-06)
8888

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ Release process:
3939

4040
* Confirm that `master` passes CI tests
4141
* Run `npm run release` or in case it's a prerelease you'd run i.e. `npm run release -- --prerelease alpha`
42-
* It will automatically update teh version in package.json and make a git tag.
42+
* It will automatically update the version in package.json and make a git tag.
4343
* Push commits
4444
* npm publish

docs/THEMING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ for some ideas.
3434
- You can now make changes that will show up when you generate your docs using your theme. Example `package.json` `scripts` entry: `"documentation build index.js -f html -o docs --theme node_modules/docjs-theme"`
3535

3636
#### Changes to Default Theme Via documentation.yml
37+
3738
If a documentation.yml file is used to establish a table of contents for your documentation, small changes to the default style can be made via a <style> element in the documentation.yml file.
3839

3940
For example, if you have you have a section header and text to describe the section, you can put it at the same level of the text as shown below:
@@ -60,7 +61,7 @@ For example, if you have you have a section header and text to describe the sect
6061
### Sub Section header
6162
Text that describes the section and sub-section here.
6263
```
63-
Any changes to elements and classes that also exist in the standard theme will be overwridden by what is in the documentation.yml. This opens up the possiblitity of the same CSS being defined twice, which can be confusing and is not best practice. However, it is easy to change HTML style this way. Recommend only using classes defined this way that do not exist in the standard documentation.js theme.
64+
Any changes to elements and classes that also exist in the standard theme will be overwritten by what is in the documentation.yml. This opens up the possibility of the same CSS being defined twice, which can be confusing and is not best practice. However, it is easy to change HTML style this way. Recommend only using classes defined this way that do not exist in the standard documentation.js theme.
6465

6566
### Theming Markdown
6667

src/output/markdown_ast.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ function buildMarkdownAST(comments, config) {
5555

5656
/**
5757
* Generate an AST chunk for a comment at a given depth: this is
58-
* split from the main function to handle hierarchially nested comments
58+
* split from the main function to handle hierarchically nested comments
5959
*
6060
* @param {number} depth nesting of the comment, starting at 1
6161
* @param {Object} comment a single comment

0 commit comments

Comments
 (0)