From 5f8e5298d1141213c696f0eaf1195d886f59db36 Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Tue, 10 Jul 2018 07:56:10 -0700 Subject: [PATCH 1/5] Fill out the description. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fff64a..aee26b4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # mdn-helper -Removes repetitive work of creating MDN boilerplate markup and text. +Removes repetitive work of creating MDN markup and text. Much of the work of creating a new MDN reference page is in creating boilerplate such as headings, specification tables, and standardized intro text. Once this is created API specific content must be added to the boilerplate. A significant portion of that content is duplicated between one or more pages of the API. + +This tool simplifies this process. First, it takes a command line indicating the interfaces and members to be created. It then prompts the answers to API specific content. It combines those answers with templates and writes nearly complete pages ready for pasting directly into the MDN page editor. The current version only handles JavaScript APIs. From c782aec268994ff8157d18834670f24ac67cbf64 Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Tue, 10 Jul 2018 08:06:36 -0700 Subject: [PATCH 2/5] Review README. --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aee26b4..f5fe0f3 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,19 @@ The current version only handles JavaScript APIs. ## Usage +From within the mdn-helper direcory: + `node index.js [command] [arguments]` + +Using the optional bash alias: + + `mdn-helper [command] [arguments]` ## Commands ### create -Creates MDN pages based on the submitted flags and arguments. +Creates MDN pages based on the submitted flags and arguments. The results are written to the `*path/to*/mdn-helper/out` directory. **Syntax:** `create [-i interface] [-c] [-o] [-a[memberName pageType]]` @@ -34,7 +40,7 @@ Creates MDN pages based on the submitted flags and arguments. * `-c`: Indicates that a *constructor* page should be created. * `-o`: Indicates that an *overview* page should be created. * `-a`: Indicates the name and page type of an interface member. The arguments to this flag may be repeated as many times as needed. -* `-it`: Indicates the the interface implements `iterable`. This means pages will be created for methods named `entries()`, `forEach()`, `keys()`, and `values()`. +* `-it`: Indicates that the interface implements [`iterable`](https://heycam.github.io/webidl/#idl-iterable). This means pages will be created for methods named `entries()`, `forEach()`, `keys()`, and `values()`. Since these pages use standard descriptions, you will not be prompted to provide them. **Supported page types** @@ -48,7 +54,7 @@ The following `pageTypes` are supported by the `-a` argument. ### clean -Empties the `out/` directory. +Empties the `/out` directory. ### help From ba5edd81baa1e3c5862753d7efdf37a84486d5e4 Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Tue, 10 Jul 2018 08:22:18 -0700 Subject: [PATCH 3/5] Improve syntax description. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5fe0f3..d8faa6b 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Using the optional bash alias: Creates MDN pages based on the submitted flags and arguments. The results are written to the `*path/to*/mdn-helper/out` directory. -**Syntax:** `create [-i interface] [-c] [-o] [-a[memberName pageType]]` +**Syntax:** `create [-i interface] [-c] [-o] [-a memberName1 pageType [[memberName2 pageType] ... [memberNameN pageType]]]` **Flags:** From 7963df83c98091e32976e6fa635878bf1df92fc4 Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Tue, 10 Jul 2018 08:24:20 -0700 Subject: [PATCH 4/5] Add iterable flag to syntax. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8faa6b..b599319 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Using the optional bash alias: Creates MDN pages based on the submitted flags and arguments. The results are written to the `*path/to*/mdn-helper/out` directory. -**Syntax:** `create [-i interface] [-c] [-o] [-a memberName1 pageType [[memberName2 pageType] ... [memberNameN pageType]]]` +**Syntax:** `create [-i interface] [-c] [-o] [-a memberName1 pageType [[memberName2 pageType] ... [memberNameN pageType]]] [-it]` **Flags:** From b926f789f54c0a70b85d1a31d353e65e1433630a Mon Sep 17 00:00:00 2001 From: Joe Medley Date: Tue, 10 Jul 2018 08:27:02 -0700 Subject: [PATCH 5/5] Fix usage section. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b599319..6cfaedd 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ The current version only handles JavaScript APIs. From within the mdn-helper direcory: - `node index.js [command] [arguments]` + `node index.js []` Using the optional bash alias: - `mdn-helper [command] [arguments]` + `mdn-helper []` ## Commands