aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2026-02-02all: allow combination of default and custom stylesheetShulhan
To combine default stylesheet with custom CSS, set the value to "default" and the file name of custom CSS, separated by comma. This is the recommended way to use custom stylesheet since it can be set only on specific pages. ---- // In asciidoctor: :stylesheet: default, custom.css // In markdown: stylesheet: default, custom.css ---- To disable default stylesheet and only using custom CSS, set the value only to the file name of custom CSS. Another way to use custom stylesheet is by creating your own template and pass it to `serve` or `convert` command. This method makes the stylesheet applied to all pages.
2026-01-24all: move _example/ directory under _doc/ directoryShulhan
This allow us to inspect the example using the serve-doc task, along with the content of _doc/.
2026-01-24all: embed CSS and index HTML template using memfsShulhan
Previously, with direct embed, every time we change the CSS or index template, we need to restart the "ciigo serve" command. Using memfs make us easy to update and see the changes directly, without restarting the server.
2026-01-23all: format README with prettierShulhan
While at it, simplify the license text to reference only the license name instead of snippet.
2025-06-29all: update README for pkg.go.dev and sr.htShulhan
The [Change log] link is broken when rendered on pkg.go.dev and sr.ht sites.
2025-01-07all: update README simplify section "ciigo as library"Shulhan
Instead of writing the code manually, show the where to look for example, which is at "internal/cmd/ciigo-example".
2025-01-07all: update README for running ciigo as CLIShulhan
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.
2024-08-04Release ciigo v0.13.1 (2024-08-04)v0.13.1Shulhan
=== Bug fixes * Fix "serve" not detecting new files:: If there is new files on the root of directory it will not detected automatically. This release now fix this issue. === Others * all: remove Limitations and update Links The asciidoc-go library now support scanning symlink inside Root directory. The Links sections merge the previous contents from old index.adoc. * all: update the CLI usage in the README There are three places for command usage: one in main Go doc, one in the program usage, and one in README. If we changes the flags we need to update three of them, and sometimes we forgot. To simplify, we remove the one in the Go doc main program.
2024-08-04all: update the CLI usage in the READMEShulhan
There are three places for command usage: one in main Go doc, one in the program usage, and one in README. If we changes the flags we need to update three of them, and sometimes we forgot. To simplify, we remove the one in the Go doc main program.
2024-08-04all: remove Limitations and update LinksShulhan
The asciidoc-go library now support scanning symlink inside Root directory. The Links sections merge the previous contents from old index.adoc.
2024-03-05all: replace module "share" with "pakakeh.go"Shulhan
2023-05-14README: list websites build using ciigoShulhan
2023-05-14all: convert the README back to MarkdownShulhan
This is to make it the repository page at git.sr.ht/~shulhan/ciigo and pkg.go.dev readable.
2022-08-06all: convert the README using AsciiDocShulhan
While at it, create symlink README so the git.sr.ht site can display it.
2022-03-09all: remove old license section on READMEShulhan
While at it, remove the SPDX comment at the top README to fix the markdown not rendered correctly.
2022-03-04all: re-licensing ciigo under GPL-3.0 or laterShulhan
See https://kilabit.info/journal/2022/gpl/ for more information.
2021-10-27all: update to latest share moduleShulhan
The latest share module simplify the memfs.GoEmbed call by using struct memfs.EmbedOptions instead of passing it as parameters. The changes on share module affect on how EmbedOptions in this module, where memfs.EmbedOptions is used to replace field PackageName, VarName, and GoFileName.
2021-04-03all: update README and LICENSEShulhan
Update README to reflect the latest changes and features on the ciigo as command and library. On license file, fix the year to the first commit and current year.
2021-04-03all: change the Convert function to use type ConvertOptionsShulhan
Previously, we pass the directory to be scanned for asciidoc markup files and path to HTML template on Convert function. Adding new option to Convert will cause changes on the Convert signature. To prevent this, we changes the Convert signature from multiple parameters into single parameter ConvertOptions. While at it, change the variable name HTMLTemplate to HtmlTemplate.
2021-01-21README: update the content to reflect the latest changesShulhan
Simplify the instruction on using ciigo as library.
2021-01-10all: refactoring due to change on memfs packageShulhan
This changes affect exported function Generate and Serve. Previously, the Generate() function accept three options: dir, out, and htmlTemplate; this commit changes the parameter into single struct Options with two additional options: GenPackageName and GenVarName. The GenPackageName allow to set the package name in Go generate source code, default to "main" if not set. The GenVarName set the instance of memfs.MemFS where the embedded files will be stored. On the Serve() function, we add parameter to pass the instance of memfs.MemFS (the one that passed on GenVarName).
2020-11-24README: reformat to markdown to make it readable by sourcehutShulhan
While at it simplify the example of index.adoc.