ciigo, branch v0.15.0Static web server with AsciiDoc and Markdown.http://git.kilabit.info/ciigo/atom?h=v0.15.02025-01-07T17:02:27ZRelease ciigo v0.15.0 (2025-01-08)2025-01-07T17:02:27ZShulhanms@kilabit.info2025-01-07T17:02:27Zurn:sha1:9130f2350eff5710b14ec6aeda7ddccd944c643c
This is the first major release of ciigo on the new year of 2025.
We bring many enhancements and update on the documentation.
[ENHANCEMENT]
The first changes is refactoring to use watchfs/v2. The [watchfs/v2]
bring new enhancements by watching only single file instead of all
markup files for changes. This minimize number of goroutine calling
[os.Stat] on each markup files.
[BUG FIX]
When listing the file markups, if the node is symlink (either file or
directory) and target its not exist, continue to the next node instead
of returning error. The same is true for directory that cannot be
opened, probably due to broken symlink or permission.
[ENHANCEMENT]
In development mode, where [ServeOptions.IsDevelopment] is set to true
or when running "ciigo serve", the ciigo HTTP server will check if the
new markup file is newer than HTML file when user press refresh or
reload on the browser. If its newer, it will convert the markup file and
return the new content of HTML file.
This allow quick preview without waiting for watcher to complete.
[ENHANCEMENT]
The README has been revamped to include section on how to install ciigo
as program, how to running ciigo convert and serve, how to write content
and view it live on browser, and how to deploy it.
On the section "ciigo as library" we point the user the sample code at
"internal/cmd/ciigo-example" instead of writing long code at the front.
[BUG FIX]
This release also fix Exclude option does not get processed when calling
GoEmbed, or running "ciigo embed".
all: update README simplify section "ciigo as library"2025-01-07T16:48:24ZShulhanms@kilabit.info2025-01-07T16:48:24Zurn:sha1:50b8bb50987d8fc8b848c05e07f16730a9883daf
Instead of writing the code manually, show the where to look for
example, which is at "internal/cmd/ciigo-example".
all: fix GoEmbed that does not excludes options from ConvertOptions2025-01-07T16:19:47ZShulhanms@kilabit.info2025-01-07T16:19:47Zurn:sha1:67a080cd6d2b08a192ad4b6977358645616ddb65all: move example for ciigo as library to internal/cmd/ciigo-example2025-01-07T16:19:25ZShulhanms@kilabit.info2025-01-07T16:19:25Zurn:sha1:9a03cfb3c4289b9af54246950c957265ee83ecc5
While at it, update the example index by removing unnecessary
external image, and update links to open in new tab/window.
all: update README for running ciigo as CLI2025-01-06T17:53:09ZShulhanms@kilabit.info2025-01-06T14:35:21Zurn:sha1:028580508facc0924cab1666e8aeacdc72e280a1
In the README we add list of ciigo features, describe how to install
ciigo, reformat the Usage, add an example of running ciigo convert
and serve, how to write content and view it live on browser, and
how to deploy it using rsync.
file_markup: convert extension to lowercase on markupKind only2025-01-06T17:13:55ZShulhanms@kilabit.info2025-01-06T16:32:02Zurn:sha1:51ac42c62f8b1bd0c1669c01fa445cb1ed76d02e
Converting extension to lowercase before trimming it may not remove
the extension itself since the string has changes.
all: change the "serve-doc" and default address to prevent conflicts2025-01-06T17:13:55ZShulhanms@kilabit.info2025-01-06T14:34:27Zurn:sha1:d420aa693773f5793138589745bf02ea4eea3cf7
Using port 8080 as the default address for "serve" is too common and may
conflict with other services in user local environment.
While at it, also change the "serve-doc" with other random ports to
allow us test running "ciigo serve" and viewing doc at the same time.
all: auto convert markup when HTTP client request GET to HTML file2025-01-06T17:13:55ZShulhanms@kilabit.info2025-01-05T19:54:52Zurn:sha1:85ae94f62b75372943a8ffdd705ce932a7849a8d
In development mode, where [ServeOptions.IsDevelopment] is set to true
or when running "ciigo serve", the ciigo HTTP server will check if the
new markup file is newer than HTML file when user press refresh or
reload on the browser.
If its newer, it will convert the markup file and return the new content
of HTML file.
all: run task "test" after "lint" and "build"2025-01-06T17:13:55ZShulhanms@kilabit.info2025-01-06T11:13:00Zurn:sha1:6593f4d2069790c73595f14b3312a8d83e61760e
Task for "lint" and "build" is much more faster than "test".
So if we lint or build failed, we did not waste too much times waiting
for all tests to pass.
While at it, remove linter "revive" we will use the standard linters
from Go tools itself.
all: ignore error when scanning for file markups2025-01-06T17:13:55ZShulhanms@kilabit.info2025-01-05T19:51:20Zurn:sha1:4a4ed2dce4ea4d9448d5aa03ea4040af202d2520
When listing the file markups, if the node is symlink (either file or
directory) and target its not exist, continue to the next node instead
of returning error.
The same is true for directory that cannot be opened, probably due to
broken symlink or permission.