Skip to content

Commit

Permalink
Fix typos found with cSpell (#1621)
Browse files Browse the repository at this point in the history
Fix typos found wtih cSpell
  • Loading branch information
coliff authored Jan 31, 2024
1 parent 8aae14b commit 58ae594
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The private parameter has removed, use a access

### Bug Fixes

* [@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))
* [@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))

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

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ Release process:

* Confirm that `master` passes CI tests
* Run `npm run release` or in case it's a prerelease you'd run i.e. `npm run release -- --prerelease alpha`
* It will automatically update teh version in package.json and make a git tag.
* It will automatically update the version in package.json and make a git tag.
* Push commits
* npm publish
3 changes: 2 additions & 1 deletion docs/THEMING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ for some ideas.
- 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"`

#### Changes to Default Theme Via documentation.yml

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.

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:
Expand All @@ -60,7 +61,7 @@ For example, if you have you have a section header and text to describe the sect
### Sub Section header
Text that describes the section and sub-section here.
```
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.
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.

### Theming Markdown

Expand Down
2 changes: 1 addition & 1 deletion src/output/markdown_ast.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ function buildMarkdownAST(comments, config) {

/**
* Generate an AST chunk for a comment at a given depth: this is
* split from the main function to handle hierarchially nested comments
* split from the main function to handle hierarchically nested comments
*
* @param {number} depth nesting of the comment, starting at 1
* @param {Object} comment a single comment
Expand Down

0 comments on commit 58ae594

Please sign in to comment.