From cba15c10ce1f66e92c6d1afbc2eb40662652036f Mon Sep 17 00:00:00 2001 From: Ronald Tse Date: Tue, 26 Jun 2018 15:53:38 +0800 Subject: [PATCH 1/6] Handle NOT RECOMMENDED as bcp14, fixes #99 --- lib/asciidoctor/rfc/v3/base.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/asciidoctor/rfc/v3/base.rb b/lib/asciidoctor/rfc/v3/base.rb index 41e0f35..b4ad1ca 100644 --- a/lib/asciidoctor/rfc/v3/base.rb +++ b/lib/asciidoctor/rfc/v3/base.rb @@ -130,7 +130,8 @@ def inline_break(node) BCP_KEYWORDS = [ "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", - "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL" + "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", + "MAY", "OPTIONAL" ].freeze def inline_quoted(node) From ba1216e6a3ae34e7e0856cc5da4615b6020122d2 Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Fri, 29 Jun 2018 04:37:22 +0700 Subject: [PATCH 2/6] docs: Add docs/ subtree for use with Ribose Open MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit RO integration pilot. At the time of this commit, don’t mind these and maintain only readme. --- docs/_navigation.md | 5 +++++ docs/installation.md | 19 +++++++++++++++++++ docs/overview.md | 3 +++ 3 files changed, 27 insertions(+) create mode 100644 docs/_navigation.md create mode 100644 docs/installation.md create mode 100644 docs/overview.md diff --git a/docs/_navigation.md b/docs/_navigation.md new file mode 100644 index 0000000..5ddca9c --- /dev/null +++ b/docs/_navigation.md @@ -0,0 +1,5 @@ +--- +- Introduction + - overview + - installation +--- diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..53bfe95 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,19 @@ +# Installation + +Add this line to your application’s Gemfile: + +``` +gem "asciidoctor-rfc" +``` + +And then execute: + +``` +$ bundle +``` + +Or install it yourself as: + +``` +$ gem install asciidoctor-rfc +``` diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..35930d3 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,3 @@ +# Overview + +asciidoctor-rfc lets you write Internet-Drafts and RFCs in AsciiDoc, the “asciidoctor-way”. From c67ba58d6f2492519997b0538bfe1cbcfc40612b Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Fri, 29 Jun 2018 05:13:31 +0700 Subject: [PATCH 3/6] docs: Fix navigation frontmatter structure --- docs/_navigation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/_navigation.md b/docs/_navigation.md index 5ddca9c..1635c33 100644 --- a/docs/_navigation.md +++ b/docs/_navigation.md @@ -1,5 +1,6 @@ --- -- Introduction - - overview - - installation +sections: + - Introduction + - overview + - installation --- From 06bcdebe1af55ff2a02fcf3ec367fd6273d5ef3a Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Fri, 29 Jun 2018 14:42:45 +0700 Subject: [PATCH 4/6] docs: Updated structure --- docs/installation.md | 4 +++- docs/navigation.md | 10 ++++++++++ docs/overview.md | 4 +++- 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 docs/navigation.md diff --git a/docs/installation.md b/docs/installation.md index 53bfe95..9df2f0e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,4 +1,6 @@ -# Installation +--- +title: Installation +--- Add this line to your application’s Gemfile: diff --git a/docs/navigation.md b/docs/navigation.md new file mode 100644 index 0000000..13bf03d --- /dev/null +++ b/docs/navigation.md @@ -0,0 +1,10 @@ +--- +sections: +- name: Introduction + items: + - overview + - installation +- name: Usage + items: + - basic +--- diff --git a/docs/overview.md b/docs/overview.md index 35930d3..42eeafc 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,3 +1,5 @@ -# Overview +--- +title: Overeview +--- asciidoctor-rfc lets you write Internet-Drafts and RFCs in AsciiDoc, the “asciidoctor-way”. From 8274c051fd6506f4f61763632ae000fc9f1155cc Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Fri, 29 Jun 2018 14:57:38 +0700 Subject: [PATCH 5/6] fix: Leftover improperly named navigation doc --- docs/_navigation.md | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 docs/_navigation.md diff --git a/docs/_navigation.md b/docs/_navigation.md deleted file mode 100644 index 1635c33..0000000 --- a/docs/_navigation.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sections: - - Introduction - - overview - - installation ---- From e4b6183966bf0f8d67780e893ee19dff43ff719e Mon Sep 17 00:00:00 2001 From: Anton Strogonoff Date: Fri, 29 Jun 2018 14:57:56 +0700 Subject: [PATCH 6/6] docs: Fix type in page title --- docs/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview.md b/docs/overview.md index 42eeafc..e641bf5 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,5 +1,5 @@ --- -title: Overeview +title: Overview --- asciidoctor-rfc lets you write Internet-Drafts and RFCs in AsciiDoc, the “asciidoctor-way”.