Skip to content

Commit 1d8a555

Browse files
kuafuRacekuafuRace
committed
docs: Add link to the official documentation to guide users to view the complete usage and examples
1 parent ae77267 commit 1d8a555

File tree

12 files changed

+29
-674
lines changed

12 files changed

+29
-674
lines changed

‎calendar/julian/README.cn.md‎

Lines changed: 2 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,5 @@
11
# 儒略日/简化儒略日
22

3-
简体中文 | [English](README.md) | [日本語](README.jp.md)
4-
5-
#### 用法示例
6-
##### 将 `公历` 转换成 `儒略日`
7-
```go
8-
// 默认保留 6 位小数精度
9-
carbon.Parse("2024-01-24 12:00:00").Julian().JD() // 2460334
10-
carbon.Parse("2024-01-24 13:14:15").Julian().JD() // 2460334.051563
11-
12-
// 保留 4 位小数精度
13-
carbon.Parse("2024-01-24 12:00:00").Julian().JD(4) // 2460334
14-
carbon.Parse("2024-01-24 13:14:15").Julian().JD(4) // 2460334.0516
15-
```
16-
17-
##### 将 `公历` 转换成 `简化儒略日`
18-
```go
19-
// 默认保留 6 位小数精度
20-
carbon.Parse("2024-01-24 12:00:00").Julian().MJD() // 60333.5
21-
carbon.Parse("2024-01-24 13:14:15").Julian().MJD() // 60333.551563
22-
23-
// 保留 4 位小数精度
24-
carbon.Parse("2024-01-24 12:00:00").Julian().MJD(4) // 60333.5
25-
carbon.Parse("2024-01-24 13:14:15").Julian().MJD(4) // 60333.5516
26-
```
27-
28-
##### 将 `儒略日` 转换成 `简化儒略日`
29-
```go
30-
// 默认保留 6 位小数精度
31-
carbon.CreateFromJulian(2460334).Julian().MJD() // 60333.5
32-
carbon.CreateFromJulian(2460334.051563).Julian().MJD() // 60332.551563
33-
34-
// 保留 4 位小数精度
35-
carbon.CreateFromJulian(2460334).Julian().MJD(4) // 60333.5
36-
carbon.CreateFromJulian(2460334.051563).Julian().MJD(4) // 60332.5516
37-
```
38-
39-
##### 将 `简化儒略日` 转换成 `儒略日`
40-
```go
41-
// 默认保留 6 位小数精度
42-
carbon.CreateFromJulian(60333.5).Julian().JD()() // 2460334
43-
carbon.CreateFromJulian(60333.551563).Julian().JD()() // 2460333.051563
44-
45-
// 保留 4 位小数精度
46-
carbon.CreateFromJulian(60333.5).Julian().JD(4) // 2460334
47-
carbon.CreateFromJulian(60333.551563).Julian().JD(4) // 2460333.0516
48-
```
49-
50-
##### 将 `儒略日`/`简化儒略日` 转换成 `公历`
51-
```go
52-
// 将 儒略日 转换成 公历
53-
carbon.CreateFromJulian(2460334).ToDateTimeString() // 2024-01-24 12:00:00
54-
carbon.CreateFromJulian(2460334.051563).ToDateTimeString() // 2024-01-24 13:14:15
55-
56-
// 将 简化儒略日 转换成 公历
57-
carbon.CreateFromJulian(60333.5).ToDateTimeString() // 2024-01-24 12:00:00
58-
carbon.CreateFromJulian(60333.551563).ToDateTimeString() // 2024-01-24 13:14:15
59-
```
60-
3+
简体中文 | [English](README.md) | [日本語](README.ja.md)
614

5+
`julian` 包是 `carbon` 包的一部分，请参阅 [官方文档](https://carbon.go-pkg.com/zh/usage/calendar.html#julian-day-modified-julian-day) 查看所有用法和示例。

‎calendar/julian/README.ja.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 儒略の日/簡略儒略の日
2+
3+
日本語 | [English](README.md) | [简体中文](README.cn.md)
4+
5+
`julian` バッグは `carbon` バッグの一部です，[公式ドキュメント](https://carbon.go-pkg.com/ja/usage/calendar.html#julian-day-modified-julian-day) すべての使用法と例を表示します。

‎calendar/julian/README.jp.md‎

Lines changed: 0 additions & 60 deletions
This file was deleted.

‎calendar/julian/README.md‎

Lines changed: 3 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,8 @@
11
# Julian Day/Modified Julian Day
22

3-
English | [简体中文](README.cn.md) | [日本語](README.jp.md)
3+
English | [简体中文](README.cn.md) | [日本語](README.ja.md)
44

5-
#### Usage and example
5+
Package `julian` is part of the `carbon` package, please refer to the [documentation](https://carbon.go-pkg.com/usage/calendar.html#julian-day-modified-julian-day)
6+
for all usages and examples.
67

7-
##### Convert `Gregorian` calendar to `Julian Day`
8-
```go
9-
// By default, 6 decimal places are retained for precision
10-
carbon.Parse("2024-01-24 12:00:00").Julian().JD() // 2460334
11-
carbon.Parse("2024-01-24 13:14:15").Julian().JD() // 2460334.051563
128

13-
// 4 decimal places are retained for precision
14-
carbon.Parse("2024-01-24 12:00:00").Julian().JD(4) // 2460334
15-
carbon.Parse("2024-01-24 13:14:15").Julian().JD(4) // 2460334.0516
16-
```
17-
18-
##### Convert `Gregorian` calendar to `Modified Julian Day`
19-
```go
20-
// By default, 6 decimal places are retained for precision
21-
carbon.Parse("2024-01-24 12:00:00").Julian().MJD() // 60333.5
22-
carbon.Parse("2024-01-24 13:14:15").Julian().MJD() // 60333.551563
23-
24-
// 4 decimal places are retained for precision
25-
carbon.Parse("2024-01-24 12:00:00").Julian().MJD(4) // 60333.5
26-
carbon.Parse("2024-01-24 13:14:15").Julian().MJD(4) // 60333.5516
27-
```
28-
29-
##### Convert `Julian Day` to `Modified Julian Day`
30-
```go
31-
// By default, 6 decimal places are retained for precision
32-
carbon.CreateFromJulian(2460334).Julian().MJD() // 60333.5
33-
carbon.CreateFromJulian(2460334.051563).Julian().MJD() // 60332.551563
34-
35-
// 4 decimal places are retained for precision
36-
carbon.CreateFromJulian(2460334).Julian().MJD(4) // 60333.5
37-
carbon.CreateFromJulian(2460334.051563).Julian().MJD(4) // 60332.5516
38-
```
39-
40-
##### Convert `Modified Julian Day` to `Julian Day`
41-
```go
42-
// By default, 6 decimal places are retained for precision
43-
carbon.CreateFromJulian(60333.5).Julian().JD()() // 2460334
44-
carbon.CreateFromJulian(60333.551563).Julian().JD()() // 2460333.051563
45-
46-
// 4 decimal places are retained for precision
47-
carbon.CreateFromJulian(60333.5).Julian().JD(4) // 2460334
48-
carbon.CreateFromJulian(60333.551563).Julian().JD(4) // 2460333.0516
49-
```
50-
51-
##### Convert `Julian Day`/`Modified Julian Day` to `Gregorian` calendar
52-
```go
53-
// Convert Julian Day to Gregorian calendar
54-
carbon.CreateFromJulian(2460334).ToDateTimeString() // 2024-01-24 12:00:00
55-
carbon.CreateFromJulian(2460334.051563).ToDateTimeString() // 2024-01-24 13:14:15
56-
57-
// Convert Modified Julian Day to Gregorian calendar
58-
carbon.CreateFromJulian(60333.5).ToDateTimeString() // 2024-01-24 12:00:00
59-
carbon.CreateFromJulian(60333.551563).ToDateTimeString() // 2024-01-24 13:14:15
60-
```

‎calendar/lunar/README.cn.md‎

Lines changed: 2 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,5 @@
11
# 中国农历
22

3-
简体中文 | [English](README.md) | [日本語](README.jp.md)
3+
简体中文 | [English](README.md) | [日本語](README.ja.md)
44

5-
#### 用法示例
6-
7-
> 目前仅支持公元 `1900` 年至 `2100` 年的 `200` 年时间跨度
8-
9-
##### 将 `公历` 转换成 `农历`
10-
11-
```go
12-
// 获取农历生肖
13-
carbon.Parse("2020-08-05").Lunar().Animal() // 鼠
14-
// 获取农历节日
15-
carbon.Parse("2021-02-12").Lunar().Festival() // 春节
16-
17-
// 获取农历年份
18-
carbon.Parse("2020-08-05").Lunar().Year() // 2020
19-
// 获取农历月份
20-
carbon.Parse("2020-08-05").Lunar().Month() // 6
21-
// 获取农历闰月月份
22-
carbon.Parse("2020-08-05").Lunar().LeapMonth() // 4
23-
// 获取农历日期
24-
carbon.Parse("2020-08-05").Lunar().Day() // 16
25-
// 获取农历时辰
26-
carbon.Parse("2020-08-05").Lunar().Hour() // 13
27-
// 获取农历分钟
28-
carbon.Parse("2020-08-05").Lunar().Minute() // 14
29-
// 获取农历秒数
30-
carbon.Parse("2020-08-05").Lunar().Second() // 15
31-
32-
// 获取农历日期时间字符串
33-
carbon.Parse("2020-08-05").Lunar().String() // 2020-06-16
34-
fmt.Printf("%s", carbon.Parse("2020-08-05").Lunar()) // 2020-06-16
35-
// 获取农历年字符串
36-
carbon.Parse("2020-08-05").Lunar().ToYearString() // 二零二零
37-
// 获取农历月字符串
38-
carbon.Parse("2020-08-05").Lunar().ToMonthString() // 六月
39-
// 获取农历闰月字符串
40-
carbon.Parse("2020-04-23").Lunar().ToMonthString() // 闰四月
41-
// 获取农历周字符串
42-
carbon.Parse("2020-04-23").Lunar().ToWeekString() // 周四
43-
// 获取农历天字符串
44-
carbon.Parse("2020-08-05").Lunar().ToDayString() // 十六
45-
// 获取农历日期字符串
46-
carbon.Parse("2020-08-05").Lunar().ToDateString() // 二零二零年六月十六
47-
48-
```
49-
50-
##### 将 `农历` 转化成 `公历`
51-
52-
```go
53-
// 将农历 二零二三年腊月十一 转化为 公历
54-
carbon.CreateFromLunar(2023, 12, 11, false).ToDateTimeString() // 2024-01-21 00:00:00
55-
// 将农历 二零二三年二月十一 转化为 公历
56-
carbon.CreateFromLunar(2023, 2, 11, false).ToDateTimeString() // 2023-03-02 00:00:00
57-
// 将农历 二零二三年闰二月十一 转化为 公历
58-
carbon.CreateFromLunar(2023, 2, 11, true).ToDateTimeString() // 2023-04-01 00:00:00
59-
```
60-
61-
##### 日期判断
62-
63-
```go
64-
65-
// 是否是合法农历日期
66-
carbon.Parse("0000-00-00").Lunar().IsValid() // false
67-
carbon.Parse("2020-08-05").Lunar().IsValid() // true
68-
69-
// 是否是农历闰年
70-
carbon.Parse("2020-08-05").Lunar().IsLeapYear() // true
71-
// 是否是农历闰月
72-
carbon.Parse("2020-08-05").Lunar().IsLeapMonth() // false
73-
74-
// 是否是鼠年
75-
carbon.Parse("2020-08-05").Lunar().IsRatYear() // true
76-
// 是否是牛年
77-
carbon.Parse("2020-08-05").Lunar().IsOxYear() // false
78-
// 是否是虎年
79-
carbon.Parse("2020-08-05").Lunar().IsTigerYear() // false
80-
// 是否是兔年
81-
carbon.Parse("2020-08-05").Lunar().IsRabbitYear() // false
82-
// 是否是龙年
83-
carbon.Parse("2020-08-05").Lunar().IsDragonYear() // false
84-
// 是否是蛇年
85-
carbon.Parse("2020-08-05").Lunar().IsSnakeYear() // false
86-
// 是否是马年
87-
carbon.Parse("2020-08-05").Lunar().IsHorseYear() // false
88-
// 是否是羊年
89-
carbon.Parse("2020-08-05").Lunar().IsGoatYear() // false
90-
// 是否是猴年
91-
carbon.Parse("2020-08-05").Lunar().IsMonkeyYear() // false
92-
// 是否是鸡年
93-
carbon.Parse("2020-08-05").Lunar().IsRoosterYear() // false
94-
// 是否是狗年
95-
carbon.Parse("2020-08-05").Lunar().IsDogYear() // false
96-
// 是否是猪年
97-
carbon.Parse("2020-08-05").Lunar().IsPigYear() // false
98-
```
5+
`lunar` 包是 `carbon` 包的一部分，请参阅 [官方文档](https://carbon.go-pkg.com/zh/usage/calendar.html#chinese-lunar) 查看所有用法和示例。

‎calendar/lunar/README.ja.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 中国の旧暦
2+
3+
日本語 | [English](README.md) | [简体中文](README.cn.md)
4+
5+
`julian` バッグは `carbon` バッグの一部です，[公式ドキュメント](https://carbon.go-pkg.com/ja/usage/calendar.html#chinese-lunar) すべての使用法と例を表示します。

0 commit comments

Comments
 (0)