docs: fix gramatical and typographical errors #2098

Vanesh37 · 2023-10-27T13:51:18Z

Check List

Please read and check followings before submitting a PR.

Note

No need to translate ko, pt-br, th languages if you submit a PR for documentation.

Warning

ko, pt-br, th languages document are inactive. Please, submit issue if you want to continuous contribution to them.

Minor improvements in files under docs/ directory

github-actions · 2023-10-27T13:52:22Z

Theme name validation passed.
Theme thumbnails validation completed.

uiolee

thank you for your patient work.

I have made some suggested changes, please check if they are correct

uiolee · 2023-10-29T17:01:55Z

source/docs/contributing.md


 ## Reporting Issues

 When you encounter some problems when using Hexo, you can find the solutions in [Troubleshooting](troubleshooting.html) or ask me on [GitHub](https://github.com/hexojs/hexo/issues) or [Google Group](https://groups.google.com/group/hexo). If you can't find the answer, please report it on GitHub.

 1. Represent the problem in [debug mode](commands.html#Debug_mode).
-2. Follow the steps from issue template to provide debug message and version when submitting a new issue at GitHub.
+2. Follow the steps from issue the template to provide a debug message and version when submitting a new issue at GitHub.


Suggested change

2. Follow the steps from issue the template to provide a debug message and version when submitting a new issue at GitHub.

2. Follow the steps from the issue template to provide a debug message and version when submitting a new issue at GitHub.

uiolee · 2023-10-29T17:04:38Z

source/docs/configuration.md

@@ -122,11 +122,11 @@ Setting | Description | Default
 {% note info updated_option %}
 `updated_option` controls the `updated` value when not provided in the front-matter:

- `mtime`: Use file modification date as `updated`. It is the default behavior of Hexo since 3.0.0
+- `mtime`: Use file modification date as `updated`. It has been the default behaviour of Hexo since 3.0.0


behavior not bad

uiolee · 2023-10-29T17:06:10Z

source/docs/syntax-highlight.md

@@ -22,7 +22,7 @@ code snippet
 ```
 ````

-The third syntax is a Markdown's fenced code block syntax and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out options available.
+The third syntax is Markdown's fenced code block syntax and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out the options available.


Suggested change

The third syntax is Markdown's fenced code block syntax and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out the options available.

The third syntax is Markdown's fenced code block syntax, and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out the options available.

uiolee · 2023-10-29T17:08:26Z

source/docs/tag-plugins.md

@@ -3,7 +3,7 @@ title: Tag Plugins
 ---
 Tag plugins are different from post tags. They are ported from Octopress and provide a useful way for you to quickly add specific content to your posts.

-Although you can write your posts in any formats, but the tag plugins will always be available and syntax remains the same.
+Although you can write your posts in any format, but the tag plugins will always be available and syntax remains the same.


Suggested change

Although you can write your posts in any format, but the tag plugins will always be available and syntax remains the same.

Although you can write your posts in any format, the tag plugins will always be available and syntax remains the same.

uiolee · 2023-10-29T17:09:30Z

source/docs/troubleshooting.md

@@ -98,7 +98,7 @@ Make sure you have [set up git](https://help.github.com/articles/set-up-git) on

 ### Error: ENOENT: no such file or directory

-If you get an error like `Error: ENOENT: no such file or directory` it's probably due to to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change so it breaks the automatic branching.
+If you get an error like `Error: ENOENT: no such file or directory` it's probably due to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change so it breaks the automatic branching.


Suggested change

If you get an error like `Error: ENOENT: no such file or directory` it's probably due to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change so it breaks the automatic branching.

If you get an error like `Error: ENOENT: no such file or directory` it's probably due to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change, so it breaks the automatic branching.

uiolee · 2023-10-29T17:11:09Z

source/docs/troubleshooting.md

@@ -178,7 +178,7 @@ When you can't get any command except `help`, `init` and `version` to work and y

 ## Escape Contents

-Hexo uses [Nunjucks] to render posts ([Swig] was used in older version, which share a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, single backtick ```` `{{ }}` ```` or triple backtick.
+Hexo uses [Nunjucks] to render posts ([Swig] was used in older version, which shares a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, single backtick ```` `{{ }}` ```` or triple backtick.


Suggested change

Hexo uses [Nunjucks] to render posts ([Swig] was used in older version, which shares a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, single backtick ```` `{{ }}` ```` or triple backtick.

Hexo uses [Nunjucks] to render posts ([Swig] was used in the older version, which shares a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, a single backtick ```` `{{ }}` ```` or a triple backtick.

uiolee · 2023-10-29T17:13:12Z

source/docs/writing.md


 For example, Hexo has `hexo-renderer-marked` and `hexo-renderer-ejs` installed by default, so you can write your posts in `markdown` or in `ejs`. If you have `hexo-renderer-pug` installed, then you can even write your post in pug template language.

-You can rename your posts and change to file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, so do the other formats.
+You can rename your posts and change to file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, and so do the other formats.


Suggested change

You can rename your posts and change to file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, and so do the other formats.

You can rename your posts and change the file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, and so do the other formats.

Vanesh37 · 2023-10-31T06:42:33Z

hi @uiolee , the changes are done according to your suggestions please check and merge it

Vanesh37 added 11 commits October 27, 2023 18:52

Update configuration.md

ba7e9f1

Update contributing.md

2de7c59

Update front-matter.md

1731283

Update github-pages.md

ff762a9

Update helpers.md

c2d8755

Update one-command-deployment.md

58e3f95

Update syntax-highlight.md

9c462b6

Update tag-plugins.md

c42c820

Update themes.md

71be5c3

Update troubleshooting.md

c3cc143

Update writing.md

9fc4cb3

github-actions bot added Docs source/docs en lang: en labels Oct 27, 2023

Vanesh37 changed the title ~~fix dramatical and typographical errors~~ fix gramatical and typographical errors Oct 27, 2023

uiolee changed the title ~~fix gramatical and typographical errors~~ docs: fix gramatical and typographical errors Oct 29, 2023

uiolee reviewed Oct 29, 2023

View reviewed changes

Vanesh37 added 5 commits October 31, 2023 12:04

Update contributing.md

d8e35bd

Update syntax-highlight.md

d44f97a

Update tag-plugins.md

3fb89f7

Update troubleshooting.md

e892971

Update writing.md

73e4132

uiolee approved these changes Oct 31, 2023

View reviewed changes

uiolee merged commit 0ddb974 into hexojs:master Nov 6, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix gramatical and typographical errors #2098

docs: fix gramatical and typographical errors #2098

Vanesh37 commented Oct 27, 2023

github-actions bot commented Oct 27, 2023

uiolee left a comment •

edited

Loading

uiolee Oct 29, 2023

uiolee Oct 29, 2023

uiolee Oct 29, 2023

uiolee Oct 29, 2023

uiolee Oct 29, 2023

uiolee Oct 29, 2023

uiolee Oct 29, 2023

Vanesh37 commented Oct 31, 2023

	2. Follow the steps from issue the template to provide a debug message and version when submitting a new issue at GitHub.
	2. Follow the steps from the issue template to provide a debug message and version when submitting a new issue at GitHub.

	The third syntax is Markdown's fenced code block syntax and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out the options available.
	The third syntax is Markdown's fenced code block syntax, and Hexo extends it to support more features. Check out [Tag Plugin Docs](tag-plugins#Code-Block) to find out the options available.

	Although you can write your posts in any format, but the tag plugins will always be available and syntax remains the same.
	Although you can write your posts in any format, the tag plugins will always be available and syntax remains the same.

	If you get an error like `Error: ENOENT: no such file or directory` it's probably due to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change so it breaks the automatic branching.
	If you get an error like `Error: ENOENT: no such file or directory` it's probably due to mixing uppercase and lowercase letters in your tags, categories, or filenames. Git cannot automatically merge this change, so it breaks the automatic branching.

	Hexo uses [Nunjucks] to render posts ([Swig] was used in older version, which shares a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, single backtick ```` `{{ }}` ```` or triple backtick.
	Hexo uses [Nunjucks] to render posts ([Swig] was used in the older version, which shares a similar syntax). Content wrapped with `{{ }}` or `{% %}` will get parsed and may cause problems. You can skip the parsing by wrapping it with the [`raw`](/docs/tag-plugins#Raw) tag plugin, a single backtick ```` `{{ }}` ```` or a triple backtick.

	You can rename your posts and change to file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, and so do the other formats.
	You can rename your posts and change the file extension from `.md` to `.ejs`, then Hexo will use `hexo-renderer-ejs` to render that file, and so do the other formats.

docs: fix gramatical and typographical errors #2098

docs: fix gramatical and typographical errors #2098

Conversation

Vanesh37 commented Oct 27, 2023

Check List

github-actions bot commented Oct 27, 2023

uiolee left a comment • edited Loading

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

uiolee Oct 29, 2023

Choose a reason for hiding this comment

Vanesh37 commented Oct 31, 2023

uiolee left a comment •

edited

Loading