2 | {{ range split .Inner "<--->" }}
3 |
8 |
--------------------------------------------------------------------------------
/docs/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json:
--------------------------------------------------------------------------------
1 | {"Target":"book.min.33a48f5432973b8ff9a82679d9e45d67f2c15d4399bd2829269455cfe390b5e8.css","MediaType":"text/css","Data":{"Integrity":"sha256-M6SPVDKXO4/5qCZ52eRdZ/LBXUOZvSgpJpRVz+OQteg="}}
--------------------------------------------------------------------------------
/docs/themes/hugo-book/static/svg/toc.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/mysql/0002_post_visibility.up.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE `p_post` ADD COLUMN `visibility` tinyint unsigned NOT NULL DEFAULT '0' COMMENT '可见性 0公开 1私密 2好友可见';
2 | CREATE INDEX `idx_visibility` ON `p_post` ( `visibility` ) USING BTREE;
3 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/postgres/0014_topic_user_pin.up.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE p_topic_user ADD COLUMN is_pin SMALLINT NOT NULL DEFAULT 0; -- 是否钉住 0 为未钉住、1 为已钉住
2 | CREATE INDEX idx_topic_user_uid_ispin ON p_topic_user USING btree ( user_id, is_pin );
3 |
--------------------------------------------------------------------------------
/docs/public/svg/calendar.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/examples/README.md:
--------------------------------------------------------------------------------
1 | ## Examples
2 | Some example for mir.
3 |
4 | - [mir-example](mir-example) - simple minimal mir example for explain how to use mir.
5 | - [sail-example](sail-example) - product least mir example for explain how to use mir in production enviroment.
6 |
7 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/mysql/0015_topic_user_pin.up.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE `p_topic_user` ADD COLUMN `is_pin` TINYINT NOT NULL DEFAULT 0 COMMENT '是否钉住 0 为未钉住、1 为已钉住';
2 | CREATE INDEX `idx_topic_user_uid_ispin` ON `p_topic_user` (`user_id`, `is_pin`) USING BTREE;
3 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/sqlite3/0015_topic_user_pin.up.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE "p_topic_user" ADD COLUMN "is_pin" integer NOT NULL DEFAULT 0;
2 | CREATE INDEX "main"."idx_topic_user_uid_ispin"
3 | ON "p_topic_user" (
4 | "user_id" ASC,
5 | "is_pin" ASC
6 | );
7 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/archetypes/docs.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "{{ .Name | humanize | title }}"
3 | weight: 1
4 | # bookFlatSection: false
5 | # bookToc: true
6 | # bookHidden: false
7 | # bookCollapseSection: false
8 | # bookComments: false
9 | # bookSearchExclude: false
10 | ---
11 |
--------------------------------------------------------------------------------
/mirc/templates/chi/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/echo/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/gin/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/iris/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/mux/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/assets/sw-register.js:
--------------------------------------------------------------------------------
1 | {{- $swJS := resources.Get "sw.js" | resources.ExecuteAsTemplate "sw.js" . -}}
2 | if (navigator.serviceWorker) {
3 | navigator.serviceWorker.register(
4 | "{{ $swJS.RelPermalink }}",
5 | { scope: "{{ "/" | relURL }}" }
6 | );
7 | }
8 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/layouts/partials/docs/date.html:
--------------------------------------------------------------------------------
1 |
5 | {{- $format := default "January 2, 2006" .Format -}}
6 | {{- return (.Date.Format $format) -}}
7 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/static/svg/calendar.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/mirc/templates/fiber/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/hertz/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/mirc/templates/macaron/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/exampleSite/resources/_gen/assets/scss/book.scss_e129fe35b8d0a70789c8a08429469073.json:
--------------------------------------------------------------------------------
1 | {"Target":"book.min.33a48f5432973b8ff9a82679d9e45d67f2c15d4399bd2829269455cfe390b5e8.css","MediaType":"text/css","Data":{"Integrity":"sha256-M6SPVDKXO4/5qCZ52eRdZ/LBXUOZvSgpJpRVz+OQteg="}}
--------------------------------------------------------------------------------
/mirc/templates/httprouter/servants/site.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "{{ .PkgName }}/mirc/auto/api"
5 | )
6 |
7 | type siteSrv struct {
8 | baseSrv
9 | api.UnimplementedSiteServant
10 | }
11 |
12 | func newSiteSrv() api.Site {
13 | return &siteSrv{}
14 | }
15 |
--------------------------------------------------------------------------------
/docs/public/zh/index.html:
--------------------------------------------------------------------------------
1 |
4 | {{ . | $.Page.RenderString }}
5 |
6 | {{ end }}
7 | -
2 | {{ range .Page.Pages }}
3 |
- 4 | {{ partial "docs/title" . }} 5 | 6 |
- 7 | {{ default .Summary .Description }} 8 | 9 | {{ end }} 10 |
2 | {{- $summary := cond .IsNamedParams (.Get "title") (.Get 0) -}}
3 |
8 |
--------------------------------------------------------------------------------
/mirc/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/alimy/mir/mirc/v5
2 |
3 | go 1.24.0
4 |
5 | require (
6 | github.com/Masterminds/semver/v3 v3.3.1
7 | github.com/alimy/embedx v0.6.1
8 | github.com/spf13/cobra v1.9.1
9 | )
10 |
11 | require (
12 | github.com/inconshreveable/mousetrap v1.1.0 // indirect
13 | github.com/spf13/pflag v1.0.6 // indirect
14 | )
15 |
--------------------------------------------------------------------------------
/mirc/templates/hertz/main.go.tmpl:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "{{ .PkgName }}/servants"
5 |
6 | "github.com/cloudwego/hertz/pkg/app/server"
7 | )
8 |
9 | func main() {
10 | h := server.Default()
11 |
12 | // register servants to hertz
13 | servants.RegisterServants(h.Engine)
14 |
15 | // start servant service
16 | h.Spin()
17 | }
18 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/i18n/bn.yaml:
--------------------------------------------------------------------------------
1 | - id: Search
2 | translation: অনুসন্ধান
3 |
4 | - id: Edit this page
5 | translation: এই পৃষ্ঠাটি সম্পাদনা করুন
6 |
7 | - id: Last modified by
8 | translation: সর্বশেষ সম্পাদনা করেছেন
9 |
10 | - id: Expand
11 | translation: বিস্তৃত করা
12 |
13 | - id: bookSearchConfig
14 | translation: '{ cache: true }'
15 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/i18n/uk.yaml:
--------------------------------------------------------------------------------
1 | - id: Search
2 | translation: Пошук
3 |
4 | - id: Edit this page
5 | translation: Редагувати цю сторінку
6 |
7 | - id: Last modified by
8 | translation: Остання зміна від
9 |
10 | - id: Expand
11 | translation: Розгорнути
12 |
13 | - id: bookSearchConfig
14 | translation: '{ split: /[^a-zа-яё0-9\w]/gi }'
15 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/postgres/0006_comment_thumbs.down.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE p_comment DROP COLUMN thumbs_up_count;
2 | ALTER TABLE p_comment DROP COLUMN thumbs_down_count;
3 | ALTER TABLE p_comment_reply DROP COLUMN thumbs_up_count;
4 | ALTER TABLE p_comment_reply DROP COLUMN thumbs_down_count;
5 |
6 | DROP TABLE IF EXISTS p_tweet_comment_thumbs;
7 |
--------------------------------------------------------------------------------
/internal/naming/naming.go:
--------------------------------------------------------------------------------
1 | // Copyright 2025 Michael Li {{ $summary | .Page.RenderString }}
4 |
5 | {{ .Inner | .Page.RenderString }}
6 |
7 |
2 |
3 | {{- with .Site.Params.BookLogo -}}
4 | 
5 | {{- end -}}
6 | {{ .Site.Title }}
7 |
8 |
9 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/sqlite3/0007_comment_thumbs.down.sql:
--------------------------------------------------------------------------------
1 | ALTER TABLE "p_comment" DROP COLUMN "thumbs_up_count";
2 | ALTER TABLE "p_comment" DROP COLUMN "thumbs_down_count";
3 | ALTER TABLE "p_comment_reply" DROP COLUMN "thumbs_up_count";
4 | ALTER TABLE "p_comment_reply" DROP COLUMN "thumbs_down_count";
5 |
6 | DROP TABLE IF EXISTS "p_tweet_comment_thumbs";
7 |
--------------------------------------------------------------------------------
/docs/public/sitemap.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
7 | {{ end }}
8 |
--------------------------------------------------------------------------------
/mirc/templates/echo/main.go.tmpl:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "log"
5 |
6 | "github.com/labstack/echo/v4"
7 | "{{ .PkgName }}/servants"
8 | )
9 |
10 | func main() {
11 | e := echo.New()
12 |
13 | // register servants to echo
14 | servants.RegisterServants(e)
15 |
16 | // start servant service
17 | if err := e.Start(":4000"); err != nil {
18 | log.Fatal(err)
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/mirc/main.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "github.com/alimy/mir/mirc/v5/cmd"
5 | )
6 |
7 | func main() {
8 | // setup root cli command of application
9 | cmd.Setup(
10 | "mirc", // command name
11 | "mir help toolkit", // command short describe
12 | "mir help tookit", // command long describe
13 | )
14 |
15 | // execute start application
16 | cmd.Execute()
17 | }
18 |
--------------------------------------------------------------------------------
/examples/sail-example/scripts/migration/embed.go:
--------------------------------------------------------------------------------
1 | // Copyright 2025 Michael Li {{ .Title | title }}
4 | {{ $taxonomies := index .Site.Taxonomies .Page.Type }} 5 | {{ range $taxonomies }} 6 | 7 | {{ end }} 8 |11 | {{- .Inner -}} 12 |
13 | -------------------------------------------------------------------------------- /examples/mir-example/servants/site.go: -------------------------------------------------------------------------------- 1 | // Copyright 2025 Michael Li
2 |
5 |
6 | {{ partial "docs/title" . }}
7 |
8 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/layouts/partials/docs/title.html:
--------------------------------------------------------------------------------
1 |
5 | {{ $title := "" }}
6 |
7 | {{ if .LinkTitle }}
8 | {{ $title = .LinkTitle }}
9 | {{ else if .Title }}
10 | {{ $title = .Title }}
11 | {{ else if and .IsSection .File }}
12 | {{ $title = path.Base .File.Dir | humanize | title }}
13 | {{ else if and .IsPage .File }}
14 | {{ $title = .File.BaseFileName | humanize | title }}
15 | {{ end }}
16 |
17 | {{ return $title }}
18 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/layouts/shortcodes/expand.html:
--------------------------------------------------------------------------------
1 | {{ warnf "Expand shortcode is deprecated. Use 'details' instead." }}
2 |
14 |
--------------------------------------------------------------------------------
/examples/sail-example/.gitignore:
--------------------------------------------------------------------------------
1 | # Binaries for programs and plugins
2 | .DS_Store
3 | *.exe
4 | *.exe~
5 | *.dll
6 | *.so
7 | *.dylib
8 |
9 | coverage.out
10 | count.out
11 | test
12 | profile.out
13 | tmp.out
14 |
15 | # Test binary, build with `go test -c`
16 | *.test
17 |
18 | # Output of the go coverage tool, specifically when used with LiteIDE
19 | *.out
20 |
21 | # GoLand project files
22 | .idea/
23 | *.iml
24 |
25 | # VS Code
26 | .vscode
27 |
28 | # mirc generate files
29 | .mirc
30 |
31 | /examples
32 | /sail-example
33 |
--------------------------------------------------------------------------------
/docs/content.en/docs/tutorials/app-start.md:
--------------------------------------------------------------------------------
1 | ---
2 | weight: 25
3 | title: "App Start"
4 | ---
5 |
6 | ## App Start:
7 | ```go
8 | // file: main.go
9 |
10 | package main
11 |
12 | import (
13 | "log"
14 |
15 | "github.com/alimy/mir-example/v4/servants"
16 | "github.com/gin-gonic/gin"
17 | )
18 |
19 | func main() {
20 | e := gin.Default()
21 |
22 | // register servants to gin
23 | servants.RegisterServants(e)
24 |
25 | // start servant service
26 | if err := e.Run(); err != nil {
27 | log.Fatal(err)
28 | }
29 | }
30 | ```
31 |
--------------------------------------------------------------------------------
/.golangci.yml:
--------------------------------------------------------------------------------
1 | linters-settings:
2 | staticcheck:
3 | checks: [
4 | "all",
5 | "-SA1019" # There are valid use cases of strings.Title
6 | ]
7 | nakedret:
8 | max-func-lines: 0 # Disallow any unnamed return statement
9 |
10 | linters:
11 | enable:
12 | # - unused
13 | # - errcheck
14 | # - gosimple
15 | - govet
16 | # - ineffassign
17 | # - staticcheck
18 | # - typecheck
19 | # - nakedret
20 | - gofmt
21 | # - rowserrcheck
22 | # - unconvert
23 | - goimports
24 | # - unparam
25 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/assets/plugins/_scrollbars.scss:
--------------------------------------------------------------------------------
1 | @import "defaults";
2 | @import "variables";
3 |
4 | // Webkit
5 | ::-webkit-scrollbar {
6 | width: $padding-8;
7 | }
8 |
9 | ::-webkit-scrollbar-thumb {
10 | background: transparent;
11 | border-radius: $padding-8;
12 | }
13 |
14 | :hover::-webkit-scrollbar-thumb {
15 | background: var(--gray-500);
16 | }
17 |
18 | // MS
19 | body {
20 | -ms-overflow-style: -ms-autohiding-scrollbar;
21 | }
22 |
23 | // Future
24 | .book-menu nav {
25 | scrollbar-color: transparent var(--gray-500);
26 | }
27 |
--------------------------------------------------------------------------------
/examples/sail-example/internal/servants/web/site.go:
--------------------------------------------------------------------------------
1 | // Copyright 2025 Michael Li
6 | {{- range $index, $tab := .Scratch.Get $group -}}
7 |
8 |
11 |
16 |
--------------------------------------------------------------------------------
/mirc/templates/httprouter/servants/servants.go.tmpl:
--------------------------------------------------------------------------------
1 | package servants
2 |
3 | import (
4 | "github.com/julienschmidt/httprouter"
5 | "{{ .PkgName }}/mirc/auto/api"
6 | v1 "{{ .PkgName }}/mirc/auto/api/v1"
7 | v2 "{{ .PkgName }}/mirc/auto/api/v2"
8 | v3 "{{ .PkgName }}/mirc/auto/api/v3"
9 | )
10 |
11 | // RegisterServants register all the servants to httprouter.Router
12 | func RegisterServants(e *httprouter.Router) {
13 | api.RegisterSiteServant(e, newSiteSrv())
14 | v1.RegisterSiteServant(e, newSiteSrvA())
15 | v2.RegisterSiteServant(e, newSiteSrvB())
16 | v3.RegisterSiteServant(e, newSiteSrvC())
17 | }
18 |
--------------------------------------------------------------------------------
/docs/themes/hugo-book/exampleSite/content.en/docs/shortcodes/details.md:
--------------------------------------------------------------------------------
1 | # Details
2 |
3 | Details shortcode is a helper for `details` html5 element. It is going to replace `expand` shortcode.
4 |
5 | ## Example
6 | ```tpl
7 | {{}}
8 | ## Markdown content
9 | Lorem markdownum insigne...
10 | {{}}
11 | ```
12 | ```tpl
13 | {{}}
14 | ## Markdown content
15 | Lorem markdownum insigne...
16 | {{}}
17 | ```
18 |
19 | {{< details "Title" open >}}
20 | ## Markdown content
21 | Lorem markdownum insigne...
22 | {{< /details >}}
23 |
--------------------------------------------------------------------------------
/engine/engine_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2025 Michael Li
12 | {{- .Content | $.Page.RenderString -}}
13 |
14 | {{- end -}}
15 | 5 | {{ partial "docs/title.html" . }} 6 |
7 | {{ partial "docs/post-meta" . }} 8 |9 | {{- .Summary -}} 10 | {{ if .Truncated }} 11 | ... 12 | {{ end }} 13 |
14 |5 | {{ partial "docs/title.html" . }} 6 |
7 | {{ partial "docs/post-meta" . }} 8 |9 | {{- .Summary -}} 10 | {{ if .Truncated }} 11 | ... 12 | {{ end }} 13 |
14 |{{ partial "docs/date" (dict "Date" . "Format" $.Site.Params.BookDateFormat) }}
3 | {{ end }} 4 | 5 | {{ range $taxonomy, $_ := .Site.Taxonomies }} 6 | {{ with $terms := $.GetTerms $taxonomy }} 7 |
8 | {{ range $n, $term := $terms }}{{ if $n }}, {{ end }}
9 | {{ $term.Title }}
10 | {{- end }}
11 |
12 | {{ end }}
13 | {{ end }}
14 |
15 | {{ if .Params.image }}
16 |
17 | {{ with .Resources.GetMatch .Params.image }}
18 |
19 | {{ else }}
20 |
21 | {{ end }}
22 |
-
11 | {{ range . }}
12 |
- 13 | 14 | {{- .Pre -}} 15 | {{ with .Page }} 16 | {{ partial "docs/title" .Page }} 17 | {{ else }} 18 | {{ .Name }} 19 | {{ end }} 20 | {{- .Post -}} 21 | 22 | {{- with .Children }} 23 | {{ template "book-menu-hugo" . }} 24 | {{- end }} 25 | 26 | {{ end }} 27 |