Improve the default site.json settings generated during init

[amad-person]

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Enhancement to an existing feature

Fixes #507.
Fixes #563.

What is the rationale for this request?

As per #507, the default site.json generated during markbind init can be improved by serving all .md and .mbd files by default (and ignoring .mbd files and the .git directory). Hence users need to tweak site.json only when they require some additional setup, e.g. overriding a page title.

What changes did you make? (Give an overview)

Updated the default site.json that is generated by the markbind init command as follows:

1. Added *.md and *.mbd to the pages array so that all .md and .mbd files will be served by default.
2. Added *.mbd and .git/* to the ignore array so that these files will be ignored while copying over to the generated site's directory.

Provide some example code that this change will affect:

Default site.json generated by markbind init after this change:

{
  "baseUrl": "",
  "titlePrefix": "",
  "ignore": [
    "_markbind/layouts/*",
    "_markbind/logs/*",
    "_site/*",
    "site.json",
    "*.md",
    "*.mbd",
    ".git/*"
  ],
  "pages": [
    {
      "src": "index.md",
      "title": "Hello World"
    },
    {
      "glob": "**/index.md"
    },
    {
      "glob": "**/*.+(md|mbd)"
    }
  ],
  "deploy": {
    "message": "Site Update."
  }
}

Is there anything you'd like reviewers to focus on?

N.A.

Testing instructions:

Run the test suite / build markbind locally and test.

[Xenonym]

1. Would it make sense to ignore .gitignore as well since we are already ignoring .git/*?
2. The glob patterns *.md and *.mbd would only match .md and .mbd files in the root directory of the site eg. inside/doc.md would not be matched and rendered. Is this the intended behavior?

[amad-person]

For the second point - would updating the patterns to **/*.md and **/*.mbd work?

[Xenonym]

@amad-person they should, but it doesn't seem to work in testing, see #526.

EDIT: I goofed, the above mentioned patterns should work.

[acjh]

Why are .md and .mbd in both ignore and glob?

[amad-person]

@acjh from what I understand, the requirement is that all .md and .mbd files should be rendered as HTML files i.e. they should be in glob. But the original markdown files shouldn't be copied over to the generated site directory, so .md and .mbd are in ignore also.

[Xenonym]

@amad-person **/*.md and **/.*mbd would work! In fact, you could combine them into one pattern: **/*.+(md|mbd).

However, this would also render all files in the _markbind directory eg. _markbind/variables.md, which I am not sure is useful. {,!(_markbind)/**/}*.+(md|mbd) would exclude those files, but it causes the unit test to fail, so I suspect that's intended behaviour?

[yamgent]

However, this would also render all files in the _markbind directory eg. _markbind/variables.md, which I am not sure is useful. {,!(_markbind)/**/}*.+(md|mbd) would exclude those files, but it causes the unit test to fail, so I suspect that's intended behaviour?

There's currently no way to exclude pages, and the current codebase doesn't explicitly exclude the _markbind/ directory as well. So the behaviour is expected, but I don't think it is a desirable behaviour.

It should be possible to correct the behaviour in Site.prototype.collectAddressablePages, no need to resort to complicated regex for now. :P

[amad-person]

I have updated to glob syntax to serve all files, please let me know if I need to make any changes!

[yamgent]

We still need to exclude the files inside _markbind/, by doing the following:

It should be possible to correct the behaviour in Site.prototype.collectAddressablePages

[amad-person]

@yamgent

For excluding the files inside _markbind can I change the value of BOILERPLATE_FOLDER_NAME (Site.js#28) to '_markbind'? The current value of this is '_markbind/boilerplates' and it is being used to ignore the boilerplates folder as given in Site.js#367.

[acjh]

No, boilerplate files are a feature in MarkBind and that constant is used in other places.

[acjh]

Can remove BOILERPLATE_FOLDER_NAME since it's a subdirectory of CONFIG_FOLDER_NAME?

[yamgent]

Nice work. Please squash the commits! Thank you.