Skip to content

Commit

Permalink
docs: 添加有关本地化的文档
Browse files Browse the repository at this point in the history
  • Loading branch information
caixw committed Aug 29, 2021
1 parent f24eb1c commit ef12988
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
19 changes: 19 additions & 0 deletions blogit.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
// SPDX-License-Identifier: MIT

// Package blogit 静态博客生成工具
//
//
// 本地化
//
// 在 internal/locale 提供了本地化的翻译内容,可以通过 github.com/issue9/localeutil
// 加载相应的翻译内容。
//
// 返回的错误信息,也提供了本地化支持,只要判断该错误对象是否实现了 localeutil.LocaleStringer
// 接口即可,如果实现了,调用 LocaleString() 方法会输出本地的错误信息。
// b := catalog.NewBuilder()
// localeutil.LoadMessageFromFile(b, "internal/locale/*.yaml", yaml.Unmarshal)
// p := message.NewPrinter(language.Chinese, message.Catalog(b))
//
// err := Build(...)
// if ls, ok := err.(localeutil.LocaleStringer); ok {
// println(ls.LocaleString(p)) // 输出本地化内容
// } else {
// println(err.Error())
// }
package blogit

import (
Expand Down
2 changes: 1 addition & 1 deletion builder/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func New(src fs.FS, dest WritableFS) *Builder {
// info 在运行过程中的一些提示信息通过此输出,如果为空,则会将内容写入到 io.Discard;
// base 如果不为空,则会替换 conf.yaml 配置项中的 url 字段,在预览模式下,该配置项经常会被需要修改;
//
// 返回的 error 可能也实现了 localeutil.LocaleStringer 接口。
// 返回的 error 可能实现了 localeutil.LocaleStringer 接口。
func (b *Builder) Rebuild(info *log.Logger, base string) error {
b.rebuildMux.Lock()
defer b.rebuildMux.Unlock()
Expand Down
1 change: 0 additions & 1 deletion builder/fs.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ type memoryFS struct {
*memfs.FS
}

// 文件系统可能是创建在一个非目录
type dirFS struct {
dir string
files []string
Expand Down

0 comments on commit ef12988

Please sign in to comment.