From 292bbb29aa44ff3a1632b27715596b2b00b77589 Mon Sep 17 00:00:00 2001 From: Shulhan Date: Wed, 28 Aug 2019 23:59:56 +0700 Subject: all: replace document generator from asciidoctor to ciigo Previously, generating HTML files from asciidoc files require installing ruby, asciidoctor, and its dependency through Gemfile. To simplify this, we replace it with ciigo. Ciigo not only can convert the asciidoc files but it also support serving the file inside HTTP server and watching changes on asciidoc files during development for local previewing. --- CHANGELOG.adoc | 4 +- CHANGELOG.html | 100 ++-- Gemfile | 6 - Gemfile.lock | 66 --- Guardfile | 19 - README.adoc | 110 ++-- README.html | 286 +++++----- doc/DKIM_DEVOPS.html | 467 ++++++++-------- doc/DKIM_OVERVIEW.adoc | 4 +- doc/DKIM_OVERVIEW.html | 167 +++--- doc/DKIM_SIGNATURES.html | 1065 +++++++++++++++++------------------ doc/DKIM_THREATS.html | 267 ++++----- doc/ESMTP_AUTH.adoc | 2 +- doc/ESMTP_AUTH.html | 137 ++--- doc/ESMTP_DSN.adoc | 2 +- doc/ESMTP_DSN.html | 271 ++++----- doc/ESMTP_TLS.adoc | 2 +- doc/ESMTP_TLS.html | 109 ++-- doc/IMF.adoc | 2 +- doc/IMF.html | 512 +++++++---------- doc/MIME_II_MEDIA_TYPES.html | 393 ++++++------- doc/MIME_I_FORMAT.html | 341 ++++++------ doc/MIME_V_CONFORMANCE.html | 157 +++--- doc/SASL.html | 155 +++--- doc/SASL_PLAIN.html | 87 +-- doc/SMTP.adoc | 2 +- doc/SMTP.html | 339 ++++++------ doc/SPF.html | 1257 +++++++++++++++++++++--------------------- doc/style.css | 75 ++- html.tmpl | 44 ++ lib/contact/README.html | 55 ++ lib/dsv/README.html | 365 ++++++++++++ lib/mining/README.html | 63 +++ lib/numbers/README.html | 55 ++ lib/tabula/README.html | 177 ++++++ lib/websocket/AUTOBAHN.html | 110 ++-- lib/websocket/BENCHMARK.html | 175 ++++++ 37 files changed, 4210 insertions(+), 3238 deletions(-) delete mode 100644 Gemfile delete mode 100644 Gemfile.lock delete mode 100644 Guardfile create mode 100644 html.tmpl create mode 100644 lib/contact/README.html create mode 100644 lib/dsv/README.html create mode 100644 lib/mining/README.html create mode 100644 lib/numbers/README.html create mode 100644 lib/tabula/README.html create mode 100644 lib/websocket/BENCHMARK.html diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index e1281d58..1142cf43 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -1,8 +1,8 @@ = CHANGELOG +:stylesheet: doc/style.css :toc: -This library is released each month, either at the end of month or at the -first week of next month. +This library is released each month, usually at the first week of month. == share v0.8.1 (2019-08-05) diff --git a/CHANGELOG.html b/CHANGELOG.html index 09831b35..31961a41 100644 --- a/CHANGELOG.html +++ b/CHANGELOG.html @@ -1,18 +1,32 @@ - - - - - - -CHANGELOG - - - - - + + + + +
+ Copyright 2019, Shulhan <ms@kilabit.info>. All rights reserved. +
+ Use of this source code is governed by a BSD-style license that can be + found in the LICENSE file. +
+ + diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 5c2c02bb..00000000 --- a/Gemfile +++ /dev/null @@ -1,6 +0,0 @@ -source 'https://rubygems.org' - -gem 'guard-asciidoctor' -gem 'guard-livereload' -gem 'guard-shell' -gem 'rb-inotify' diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index c5e4bcaa..00000000 --- a/Gemfile.lock +++ /dev/null @@ -1,66 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - asciidoctor (2.0.9) - coderay (1.1.2) - em-websocket (0.5.1) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - eventmachine (1.2.7) - ffi (1.10.0) - formatador (0.2.5) - guard (2.15.0) - formatador (>= 0.2.4) - listen (>= 2.7, < 4.0) - lumberjack (>= 1.0.12, < 2.0) - nenv (~> 0.1) - notiffany (~> 0.0) - pry (>= 0.9.12) - shellany (~> 0.0) - thor (>= 0.18.1) - guard-asciidoctor (0.1.1) - asciidoctor - guard (~> 2.0) - guard-compat (~> 1.1) - guard-compat (1.2.1) - guard-livereload (2.5.2) - em-websocket (~> 0.5) - guard (~> 2.8) - guard-compat (~> 1.0) - multi_json (~> 1.8) - guard-shell (0.7.1) - guard (>= 2.0.0) - guard-compat (~> 1.0) - http_parser.rb (0.6.0) - listen (3.1.5) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - ruby_dep (~> 1.2) - lumberjack (1.0.13) - method_source (0.9.2) - multi_json (1.13.1) - nenv (0.3.0) - notiffany (0.1.1) - nenv (~> 0.1) - shellany (~> 0.0) - pry (0.12.2) - coderay (~> 1.1.0) - method_source (~> 0.9.0) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) - ffi (~> 1.0) - ruby_dep (1.5.0) - shellany (0.0.1) - thor (0.20.3) - -PLATFORMS - ruby - -DEPENDENCIES - guard-asciidoctor - guard-livereload - guard-shell - rb-inotify - -BUNDLED WITH - 2.0.1 diff --git a/Guardfile b/Guardfile deleted file mode 100644 index 0fd74661..00000000 --- a/Guardfile +++ /dev/null @@ -1,19 +0,0 @@ -require 'asciidoctor' - -ignore! /.git/ - -guard 'shell' do - watch(%r{^.+\.adoc$}) {|m| - Asciidoctor.convert_file m[0] - } - watch(%r{doc/.+\.adoc$}) {|m| - Asciidoctor.convert_file m[0] - } - watch(%r{lib/websocket/AUTOBAHN.+\.adoc$}) {|m| - Asciidoctor.convert_file m[0] - } -end - -guard 'livereload' do - watch(%r{^.+\.(css|js|html)$}) -end diff --git a/README.adoc b/README.adoc index b44153a2..6456f50b 100644 --- a/README.adoc +++ b/README.adoc @@ -14,129 +14,129 @@ A collection of libraries and tools written in Go. == Command Line Interface -* link:{url-godoc}/cmd/gofmtcomment[*gofmtcomment*^]: Program to convert - multilines "/\*\*/" comment into single line "//" format. +* link:{url-godoc}/cmd/gofmtcomment[*gofmtcomment*]: Program to convert + multilines "/**/" comment into single line "//" format. -* link:{url-godoc}/cmd/smtpcli[*smtpcli*^]: Command smtpcli provide a command +* link:{url-godoc}/cmd/smtpcli[*smtpcli*]: Command smtpcli provide a command line interface to SMTP client protocol. == Libraries -* link:{url-godoc}/lib/ascii[*ascii*^]: A library for working with ASCII +* link:{url-godoc}/lib/ascii[*ascii*]: A library for working with ASCII characters. -* link:{url-godoc}/lib/bytes[*bytes*^]: A library for working with slice of +* link:{url-godoc}/lib/bytes[*bytes*]: A library for working with slice of bytes. -* link:{url-godoc}/lib/contact[*contact*^]: A library to import contact from +* link:{url-godoc}/lib/contact[*contact*]: A library to import contact from Google, Microsoft, or Yahoo -* link:{url-godoc}/lib/crypto[*crypto*^]: Package crypto provide a wrapper +* link:{url-godoc}/lib/crypto[*crypto*]: Package crypto provide a wrapper for standard crypto package. -* link:{url-godoc}/lib/dns[*dns*^]: A library for working with Domain Name +* link:{url-godoc}/lib/dns[*dns*]: A library for working with Domain Name System (DNS) protocol. -* link:{url-godoc}/lib/dsv[*dsv*^]: A library for working with delimited +* link:{url-godoc}/lib/dsv[*dsv*]: A library for working with delimited separated value (DSV). -* link:{url-godoc}/lib/email[*email*^]: A library for working with Internet +* link:{url-godoc}/lib/email[*email*]: A library for working with Internet Message Format as defined by RFC 5322. -** link:{url-godoc}/lib/email/dkim[*dkim*^]: A library to parse and create +** link:{url-godoc}/lib/email/dkim[*dkim*]: A library to parse and create DKIM-Signature header field value, as defined in RFC 6376. -** link:{url-godoc}/lib/email/maildir[*maildir*^]: A library to manage email +** link:{url-godoc}/lib/email/maildir[*maildir*]: A library to manage email using maildir format. -* link:{url-godoc}/lib/errors[*errors*^]: Package errors provide an error +* link:{url-godoc}/lib/errors[*errors*]: Package errors provide an error type with code. -* link:{url-godoc}/lib/floats[*floats*^]: A library for working with slice of +* link:{url-godoc}/lib/floats[*floats*]: A library for working with slice of floats. -* link:{url-godoc}/lib/git[*git*^]: A wrapper for git command line interface. +* link:{url-godoc}/lib/git[*git*]: A wrapper for git command line interface. -* link:{url-godoc}/lib/http[*http*^]: Custom HTTP server with memory file +* link:{url-godoc}/lib/http[*http*]: Custom HTTP server with memory file system and simplified routing handler. -* link:{url-godoc}/lib/ini[*ini*^]: A library for reading and writing INI +* link:{url-godoc}/lib/ini[*ini*]: A library for reading and writing INI configuration as defined by Git configuration file syntax. -* link:{url-godoc}/lib/ints[*ints*^]: A library for working with slice of +* link:{url-godoc}/lib/ints[*ints*]: A library for working with slice of integer. -* link:{url-godoc}/lib/ints[*ints64*^]: A library for working with slice of +* link:{url-godoc}/lib/ints[*ints64*]: A library for working with slice of 64 bit integer. -* link:{url-godoc}/lib/io[*io*^]: A library for reading and watching file, +* link:{url-godoc}/lib/io[*io*]: A library for reading and watching file, and reading from standard input. -* link:{url-godoc}/lib/memfs[*memfs*^]: A library for mapping file system +* link:{url-godoc}/lib/memfs[*memfs*]: A library for mapping file system into memory. -* link:{url-godoc}/lib/mining[*mining*^]: A library for data mining. +* link:{url-godoc}/lib/mining[*mining*]: A library for data mining. -** link:{url-godoc}/lib/mining/classifier/cart[*classifier/cart*^]: +** link:{url-godoc}/lib/mining/classifier/cart[*classifier/cart*]: Implementation of the Classification and Regression Tree by Breiman, et al. -** link:{url-godoc}/lib/mining/classifier/crf[*classififer/crf*^]: +** link:{url-godoc}/lib/mining/classifier/crf[*classififer/crf*]: Implementation of the Cascaded Random Forest (CRF) algorithm, proposed by Baumann, Florian, et al. -** link:{url-godoc}/lib/mining/classifier/rf[*classifier/rf*^]: +** link:{url-godoc}/lib/mining/classifier/rf[*classifier/rf*]: Implementation of ensemble of classifiers using random forest algorithm by Breiman and Cutler. -** link:{url-godoc}/lib/mining/gain/gini[*gain/gini*^]: A library to +** link:{url-godoc}/lib/mining/gain/gini[*gain/gini*]: A library to calculate Gini gain. -** link:{url-godoc}/lib/mining/knn[*knn*^]: Implementation of the K +** link:{url-godoc}/lib/mining/knn[*knn*]: Implementation of the K Nearest Neighbor (KNN) using Euclidian to compute the distance between samples. -** link:{url-godoc}/lib/mining/math[*math*^]: A library for working with +** link:{url-godoc}/lib/mining/math[*math*]: A library for working with mathematic. -** link:{url-godoc}/lib/mining/resampling/lnsmote[*resampling/lnsmote*^]: +** link:{url-godoc}/lib/mining/resampling/lnsmote[*resampling/lnsmote*]: Implementation of the Local-Neighborhood algorithm from the paper of Maciejewski, Tomasz, and Jerzy Stefanowski. -** link:{url-godoc}/lib/mining/resampling/smote[*resampling/smote*^]: +** link:{url-godoc}/lib/mining/resampling/smote[*resampling/smote*]: Implementation of the Synthetic Minority Oversampling TEchnique (SMOTE). -** link:{url-godoc}/lib/mining/tree/binary[*tree/binary*^]: Implementation of +** link:{url-godoc}/lib/mining/tree/binary[*tree/binary*]: Implementation of binary tree. -* link:{url-godoc}/lib/net[*net*^]: Constants and library for networking. +* link:{url-godoc}/lib/net[*net*]: Constants and library for networking. -* link:{url-godoc}/lib/numbers[*numbers*^]: A library for working with +* link:{url-godoc}/lib/numbers[*numbers*]: A library for working with integer, float, slice of integer, and slice of floats. -* link:{url-godoc}/lib/runes[*runes*^]: A library for working with slice of +* link:{url-godoc}/lib/runes[*runes*]: A library for working with slice of rune. -* link:{url-godoc}/lib/smtp[*smtp*^]: A library for building SMTP server or +* link:{url-godoc}/lib/smtp[*smtp*]: A library for building SMTP server or client. This package is working in progress. -* link:{url-godoc}/lib/strings[*strings*^]: A library for working with slice +* link:{url-godoc}/lib/strings[*strings*]: A library for working with slice of string. -* link:{url-godoc}/lib/tabula[*tabula*^]: A library for working with rows, +* link:{url-godoc}/lib/tabula[*tabula*]: A library for working with rows, columns, or matrix (table), or in another terms working with data set. -* link:{url-godoc}/lib/test[*test*^]: A library for helping with testing. +* link:{url-godoc}/lib/test[*test*]: A library for helping with testing. -* link:{url-godoc}/lib/text[*text*^]: A library for working with text. +* link:{url-godoc}/lib/text[*text*]: A library for working with text. -** link:{url-godoc}/lib/text/diff[*text/diff*^]: Text comparison. +** link:{url-godoc}/lib/text/diff[*text/diff*]: Text comparison. -* link:{url-godoc}/lib/time[*time*^]: A library for working with time. +* link:{url-godoc}/lib/time[*time*]: A library for working with time. -* link:{url-godoc}/lib/websocket[*websocket*^]: Websocket library for server +* link:{url-godoc}/lib/websocket[*websocket*]: Websocket library for server and client. The websocket is tested with autobahn testsuite with 100% success rate. See link:{url-github-master}/lib/websocket/AUTOBAHN.adoc[the status @@ -145,7 +145,7 @@ reports]. == Changelog -include::CHANGELOG.adoc[] +link:CHANGELOG.html[CHANGELOG]. == Documentations @@ -184,21 +184,31 @@ NOTE: The links below is used to be viewed locally, not through Github. * link:doc/SPF.html[Sender Policy Framework version 1 (RFC 7208)] -=== Development +The documentation created using +https://github.com/shuLhan/ciigo[`ciigo`]. +First, install `ciigo` command line interface, -The documentation created using asciidoctor. First, install `ruby` and -`bundler`, and then execute `bundler` on source root directory. +---- +$ go install github.com/shuLhan/ciigo/cmd/ciigo +---- -During development of documentation execute, +and then run ---- -$ bundler exec guard -i +$ ciigo -template=html.tmpl serve . ---- -to watch changes on documentation files (".adoc") and regenerate the HTML +to serve documentation on HTTP server at http://127.0.0.1:8080 and watch +changes on documentation files (".adoc") and regenerate the HTML files. +To generate HTML files for all asciidoc and markdown files, run + +---- +$ ciigo -template=html.tmpl convert . +---- + == Credits -* link:https://github.com/crossbario/autobahn-testsuite[Autobahn testsuite^] +* link:https://github.com/crossbario/autobahn-testsuite[Autobahn testsuite] diff --git a/README.html b/README.html index e8d80bb4..f922d2a6 100644 --- a/README.html +++ b/README.html @@ -1,42 +1,46 @@ - - - - - - - -import "github/shuLhan/share" - - - - + + +
+ Copyright 2019, Shulhan <ms@kilabit.info>. All rights reserved. +
+ Use of this source code is governed by a BSD-style license that can be + found in the LICENSE file. +
+ + diff --git a/doc/DKIM_DEVOPS.html b/doc/DKIM_DEVOPS.html index d674d255..fc2cc860 100644 --- a/doc/DKIM_DEVOPS.html +++ b/doc/DKIM_DEVOPS.html @@ -1,94 +1,102 @@ - - - - - - - -DomainKeys Identified Mail (DKIM) Development, Deployment, and Operations - - - -