diff options
| -rw-r--r-- | README.md | 38 | ||||
| -rw-r--r-- | cmd/ciigo/main.go | 23 |
2 files changed, 29 insertions, 32 deletions
@@ -9,8 +9,11 @@ markup format. As showcase, the following websites are build using ciigo, -* [kilabit.info](https://kilabit.info) -* [golang-id.org](https://golang-id.org) +* [kilabit.info](https://kilabit.info) - + [Source code](https://git.sr.ht/~shulhan/kilabit.info). + +* [golang-id.org](https://golang-id.org) - + [Source code](https://git.sr.ht/~shulhan/golang-id-web). ## ciigo as CLI @@ -21,30 +24,47 @@ markup files, as HTML files. ### Usage ``` -$ ciigo [-template <file>] [-exclude <regex>] convert <dir> +ciigo [-template <file>] [-exclude <regex>] convert <dir> ``` -Scan the "dir" recursively to find markup files (.adoc) and convert them into -HTML files. +Scan the "dir" recursively to find markup files (.adoc or .md) and convert +them into HTML files. The template "file" is optional, default to embedded HTML template. ``` -$ ciigo [-template <file>] [-exclude <regex>] [-out <file>] generate <dir> +ciigo [-template <file>] [-exclude <regex>] [-out <file>] \ + [-package-name <string>] [-var-name <string>] \ + embed <dir> ``` -Convert all markup files inside directory "dir" recursively and then -embed them into ".go" source file. +Convert all markup files inside directory "dir" recursively and then embed +them into ".go" source file. The output file is optional, default to "ciigo_static.go" in current directory. +The package name default to main. +The variable name default to memFS. + +``` +ciigo help +``` + +Print the usage. ``` -$ ciigo [-template <file>] [-exclude <regex>] [-address <ip:port>] serve <dir> +ciigo [-template <file>] [-exclude <regex>] [-address <ip:port>] \ + serve <dir> ``` Serve all files inside directory "dir" using HTTP server, watch changes on markup files and convert them to HTML files automatically. If the address is not set, its default to ":8080". +``` +ciigo version +``` + +Print the current ciigo version. + ## ciigo as library diff --git a/cmd/ciigo/main.go b/cmd/ciigo/main.go index 9b5184d..d4d4fc9 100644 --- a/cmd/ciigo/main.go +++ b/cmd/ciigo/main.go @@ -3,29 +3,6 @@ // ciigo is a CLI to convert, embed, and/or serve a directory that contains // markup files, as HTML files. -// -// # Usage -// -// The following section describe how to use ciigo CLI. -// -// ciigo [-template <file>] [-exclude <regex>] convert <dir> -// -// Scan the "dir" recursively to find markup files and convert them into HTML -// files. -// The template "file" is optional, default to embedded HTML template. -// -// ciigo [-template <file>] [-exclude <regex>] [-out <file>] embed <dir> -// -// Convert all the markup files inside directory "dir" recursively and then -// embed them into ".go" source file. -// The output file is optional, default to "ciigo_static.go" in current -// directory. -// -// ciigo [-template <file>] [-exclude <regex>] [-address <ip:port>] serve <dir> -// -// Serve all files inside directory "dir" using HTTP server, watch changes on -// markup files and convert them to HTML files. -// If the address is not set, its default to ":8080". package main import ( |