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

docs(install): update local installation guide #2179

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

stevenjoezhang
Copy link
Member

Check List

Please read and check followings before submitting a PR.

See https://github.com/orgs/hexojs/discussions/5489

  • I want to publish my theme on Hexo official website.
    • I have read the theme publishing doc.
    • name is unique.
    • link URL is correct.
    • preview URL is correct.
    • preview URL web site is rendered correctly.
    • Add a screenshot to source/themes/screenshots.
    • Screenshot filename is same as value of name.
    • Screenshot size is 800 * 500.
    • Screenshot file format is png.
  • I want to publish my plugin on Hexo official website.
  • Others (Update, fix, translation, etc...)
    • Languages:
    • en English
    • ru Russian
    • zh-cn simplified Chinese
    • zh-tw traditional Chinese
    • ja Japanese

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.

@github-actions github-actions bot added Docs source/docs zh lang: zh-cn && zh-tw infra infrastructure, configuration of this repo en lang: en ko lang: ko pt-br lang: pt-br ru lang: ru th labg: th ja labels May 12, 2024
Copy link
Contributor

Theme thumbnails validation completed.

Copy link
Contributor

@KentarouTakeda KentarouTakeda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After git clone, it would be more accurate to move to the cloned directory.

source/docs/index.md Outdated Show resolved Hide resolved
source/ja/docs/index.md Outdated Show resolved Hide resolved
source/ko/docs/index.md Outdated Show resolved Hide resolved
source/pt-br/docs/index.md Outdated Show resolved Hide resolved
source/ru/docs/index.md Outdated Show resolved Hide resolved
source/th/docs/index.md Outdated Show resolved Hide resolved
source/zh-cn/docs/index.md Show resolved Hide resolved
source/zh-tw/docs/index.md Outdated Show resolved Hide resolved
stevenjoezhang and others added 9 commits May 13, 2024 00:16
Co-authored-by: D-Sketon <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>
Co-authored-by: KentarouTakeda <[email protected]>
Signed-off-by: Mimi <[email protected]>

then run Hexo using `hexo <command>`
```bash
echo 'PATH="$PATH:./node_modules/.bin"' >> ~/.profile
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to delete this part of modifying path setting. Modifying path may be a dangerous action. For example, some bin of node_modules overwrite some user's software, or some node_modules contain dangerous actions or even malicious code. For those familiar with Linux, they know how to do. For ordinary users, just recommend that they use npx hexo.

If anyone thinks npx hexo is too long, consider using alias

@uiolee
Copy link
Member

uiolee commented May 17, 2024

I'm sorry.

These changes confuse me.
The sub-title is "install hexo", but it actually installed hexo-cli.
And after git clone npm install, we've actually finished the setup of website.

Let's figure out what exactly we want to express.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs source/docs en lang: en infra infrastructure, configuration of this repo ja ko lang: ko pt-br lang: pt-br ru lang: ru th labg: th zh lang: zh-cn && zh-tw
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants