README
¶
github.com/TwilightUncle/ssgen
静的サイト生成。
主にマークダウンをHTMLに変換。
利用モジュール
- github.com/gin-gonic/gin
- github.com/russross/blackfriday
パッケージダウンロード
go mod tidy
サイト内リンク用のMD記法
1. <str>を表示し、<str>に該当する画面(マークダウン)のリンクを生成
[{str}]
2. <str>を表示し、<str>に合致する見出し要素へのリンクを生成
[{str#}]
3. <str>を表示し、<path>に合致する画面(マークダウン)のリンクを生成
[{str|path}]
4. <str>を表示し、<id>に合致する見出し要素へのリンクを生成
[{str#id}]
5. <str>を表示し、<path>に該当する画面(マークダウン)中の<id>の見出しへのリンクを生成
[{str|path#id}]
オプション
- -preview - サーバーを起動し、動的サーバーとしてレンダリングを行う
- -preview-static - 静的サイトの構築と出力を行ったうえで、静的ファイルを返すだけのサーバーを起動する
- オプションなし - 静的サイトの構築と出力のみ
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Core ¶
type Core struct {
// htmlへ返還前のマークダウンに対して行う処理リスト
MdMiddlewareList middleware.MiddlewareList
// 変換後のhtmlに対して行う処理リスト
HtmlMiddlewareList middleware.MiddlewareList
MdPaths access_md.MdPaths
LayoutBuilder LayoutBuilder
BaseUrl string
AssetsPath string
TemplateDir string
TemplateHtmlName string
OutputDir string
UrlSuffix string
// contains filtered or unexported fields
}
type LayoutBuilder ¶
func MakeDefaultLayoutBuilder ¶
func MakeDefaultLayoutBuilder(baseUrl string, assetsPath string, mdLayoutDir string) (LayoutBuilder, error)
テンプレートの組み上げ
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.