Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
KentarouTakeda committed Mar 22, 2024
1 parent 59dca39 commit 90e1f14
Show file tree
Hide file tree
Showing 46 changed files with 1,591 additions and 1,647 deletions.
50 changes: 25 additions & 25 deletions source/ja/api/box.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
---
title: Box
title: ボックス
---
Box is a container used for processing files in a specified folder. Hexo uses two different boxes: `hexo.source` and `hexo.theme`. The former is used to process the `source` folder and the latter to process the `theme` folder.
ボックスは指定されたフォルダ内のファイルを処理するために使用されるコンテナです。Hexoでは2種類のボックスが使用されます:`hexo.source``hexo.theme`です。前者は`source`フォルダを処理するために、後者は`theme`フォルダを処理するために使用されます。

## Load Files
## ファイルの読み込み

Box provides two methods for loading files: `process` and `watch`. `process` loads all files in the folder. `watch` does the same, but also starts watching for file changes.
ボックスはファイルを読み込むために`process``watch`の2つの方法を提供します。`process`はフォルダ内のすべてのファイルを読み込みます。`watch`も同様の操作を行いますが、ファイルの変更を監視も開始します。

``` js
```js
box.process().then(function(){
// ...
});

box.watch().then(function(){
// You can call box.unwatch() later to stop watching.
// 後で box.unwatch() を呼び出して監視を停止できます。
});
```

## Path Matching
## パスマッチング

Box provides many ways for path matching. You can use a regular expression, a function or an Express-style pattern string. For example:
ボックスはパスマッチングのための多くの方法を提供します。正規表現、関数、またはExpressスタイルのパターン文字列を使用できます。例えば:

``` plain
posts/:id => posts/89
posts/*path => posts/2015/title
```

See [util.Pattern] for more info.
詳細については[util.Pattern]を参照してください。

## Processors
## プロセッサ

A processor is an essential element of Box and is used to process files. You can use path matching as described above to restrict what exactly the processor should process. Register a new processor with the `addProcessor` method.
プロセッサはボックスの重要な要素であり、ファイルを処理するために使用されます。上記のパスマッチングを使用して、プロセッサが処理すべき正確なものを制限できます。新しいプロセッサを`addProcessor`メソッドで登録します。

``` js
box.addProcessor('posts/:id', function(file){
//
});
```

Box passes the content of matched files to processors. This information can then be read straight from the `file` argument in the callback:
ボックスはマッチしたファイルの内容をプロセッサに渡します。この情報はコールバックの`file`引数から直接読むことができます:

Attribute | Description
属性 | 説明
--- | ---
`source` | Full path of the file
`path` | Relative path to the box of the file
`type` | File type. The value can be `create`, `update`, `skip`, `delete`.
`params` | The information from path matching.
`source` | ファイルの完全なパス
`path` | ファイルのボックスまでの相対パス
`type` | ファイルのタイプ。値は`create`, `update`, `skip`, `delete`があります。
`params` | パスマッチングからの情報。

Box also provides some methods so you don't have to do file IO by yourself.
ボックスはファイルIOを自分で行う必要がないようにいくつかのメソッドも提供しています。

Method | Description
方法 | 説明
--- | ---
`read` | Read a file
`readSync` | Read a file synchronously
`stat` | Read the status of a file
`statSync` | Read the status of a file synchronously
`render` | Render a file
`renderSync` | Render a file synchronously
`read` | ファイルを読み込む
`readSync` | 同期的にファイルを読み込む
`stat` | ファイルのステータスを読み込む
`statSync` | 同期的にファイルのステータスを読み込む
`render` | ファイルをレンダリングする
`renderSync` | 同期的にファイルをレンダリングする

[util.Pattern]: https://github.com/hexojs/hexo-util#patternrule
36 changes: 18 additions & 18 deletions source/ja/api/console.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
title: Console
title: コンソール
---
The console forms the bridge between Hexo and its users. It registers and describes the available console commands.
コンソールはHexoとそのユーザー間の橋渡しをする役割を果たします。利用可能なコンソールコマンドを登録し説明します。

## Synopsis
## 概要

``` js
hexo.extend.console.register(name, desc, options, function(args){
// ...
});
```

Argument | Description
引数 | 説明
--- | ---
`name` | Name
`desc` | Description
`options`| Options
`name` | 名前
`desc` | 説明
`options`| オプション

An argument `args` will be passed into the function. This is the argument that users type into the terminal. It's parsed by [Minimist].
関数には引数`args`が渡されます。これはユーザーがターミナルに入力する引数です。[Minimist]によって解析されます。

## Options
## オプション

### usage

The usage of a console command. For example:
コンソールコマンドの使用方法。例えば:

``` js
{usage: '[layout] <title>'}
Expand All @@ -32,37 +32,37 @@ The usage of a console command. For example:

### arguments

The description of each argument of a console command. For example:
コンソールコマンドの各引数の説明。例えば:

``` js
{
arguments: [
{name: 'layout', desc: 'Post layout'},
{name: 'title', desc: 'Post title'}
{name: 'layout', desc: '投稿のレイアウト'},
{name: 'title', desc: '投稿のタイトル'}
]
}
```

### options

The description of each option of a console command. For example:
コンソールコマンドの各オプションの説明。例えば:

``` js
{
options: [
{name: '-r, --replace', desc: 'Replace existing files'}
{name: '-r, --replace', desc: '既存のファイルを置き換える'}
]
}
```

### desc

More detailed information about a console command.
コンソールコマンドについてのより詳細な情報。

## Example
##

``` js
hexo.extend.console.register('config', 'Display configuration', function(args){
hexo.extend.console.register('config', '設定を表示する', function(args){
console.log(hexo.config);
});
```
Expand Down
8 changes: 4 additions & 4 deletions source/ja/api/deployer.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Deployer
title: デプロイヤー
---
A deployer helps users quickly deploy their site to a remote server without complicated commands.
デプロイヤーは、複雑なコマンドなしにユーザーが自分のサイトをリモートサーバーに迅速にデプロイするのを助けます。

## Synopsis
## 概要

``` js
hexo.extend.deployer.register(name, function(args){
// ...
});
```

An argument `args` will be passed into the function. It contains the `deploy` value set in `_config.yml`, as well as the exact input users typed into their terminal.
関数には引数`args`が渡されます。これには`_config.yml`で設定された`deploy`の値と、ユーザーがターミナルに入力した正確な入力が含まれます。
28 changes: 14 additions & 14 deletions source/ja/api/events.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
---
title: Events
title: イベント
---
Hexo inherits from [EventEmitter]. Use the `on` method to listen for events emitted by Hexo, and use the `emit` method to emit events. For more information, refer to the Node.js API documentation.
Hexoは[EventEmitter]を継承しています。Hexoからのイベントの発火を監視するには`on`メソッドを、イベントを発火させには`emit`メソッドを使用します。詳細については、Node.jsのAPIドキュメントを参照してください。

### deployBefore

Emitted before deployment begins.
デプロイを開始する前に発火します。

### deployAfter

Emitted after deployment finishes.
デプロイが終了した後に発火します。

### exit

Emitted before Hexo exits.
Hexoが終了する前に発火します。

### generateBefore

Emitted before generation begins.
生成を開始する前に発火します。

### generateAfter

Emitted after generation finishes.
生成が終了した後に発火します。

### new

Emitted after a new post has been created. This event returns the post data:
新しい投稿が作成された後に発火します。このイベントには、投稿データが入力されます:

``` js
hexo.on('new', function(post){
//
});
```

Data | Description
データ | 説明
--- | ---
`post.path` | Full path of the post file
`post.content` | Content of the post file
`post.path` | 投稿ファイルの完全なパス
`post.content` | 投稿ファイルの内容

### processBefore

Emitted before processing begins. This event returns a path representing the root directory of the box.
プロセッサーによる処理が始まる前に発火します。このイベントには、ボックスのルートディレクトリを表すパスが入力されます。

### processAfter

Emitted after processing finishes. This event returns a path representing the root directory of the box.
プロセッサーによる処理が終了した後に発火します。このイベントには、ボックスのルートディレクトリを表すパスが入力されます。

### ready

Emitted after initialization finishes.
初期化が終了した後に発火します。

[EventEmitter]: https://nodejs.org/dist/latest/docs/api/events.html
Loading

0 comments on commit 90e1f14

Please sign in to comment.