Allow configs to be functions

[trusktr]

Summary

Allows user configs to be functions. A function config is passed an instance of the vm, which can be useful for referencing in other parts of the config, like in markdown.renderer hooks.

Also adds some unit tests in docsify.test.js to

• test that the existing Docsify API is available globally when loaded via script tag.
• test that Docsify accepts a config function (window.$docsify being a function that returns a config object)

What kind of change does this PR introduce? (check at least one)

• Bugfix
• Feature
• Code style update
• Refactor
• Docs
• Build-related changes
• Other, please describe:

Does this PR introduce a breaking change? (check one)

• Yes
• No

The PR fulfills these requirements:

• When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

• Chrome
• Firefox
• Safari
• Edge
• IE

If adding a new feature, the PR's description includes:

• A convincing reason for adding this feature
• Related documents have been updated
• Related unit tests have been updated
• e2e tests have been updated

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/pliopfhjf
✅ Preview: https://docsify-preview-git-allow-config-function.docsify-core.vercel.app

[trusktr]

Gotta check what's going on with the failed e2e test.

[trusktr]

Running npm run test:e2e passes for me locally.

[trusktr]

Ooooh, is it because of older Node for one run of the test perhaps? I'll get back to this tomorrow.

[trusktr]

Looks like I should re-do my commits to use the feat:, fix:, etc prefixes.

[trusktr]

I tried switching to Node v10 locally, ran npm run test:e2e and all tests passed. Is there a different way to test it?

[anikethsaha]

Looks like I should re-do my commits to use the feat:, fix:, etc prefixes.

yes, refer angular commit convention. I will add commitlint soon to guide with the commit message.

[trusktr]

I will add commitlint soon to guide with the commit message.

Worth checking out semantic-release too. But that would be some work to set up. I feel like we need to clean things up, add tests, etc, first.

[anikethsaha]

Worth checking out semantic-release too. But that would be some work to set up. I feel like we need to clean things up, add tests, etc, first.

yea, this will need changes in the publish script.

[trusktr]

I just noticed something else! All tests pass (at least for me locally, not sure why it fails on CI yet), however, the npm run build command currently has a Rollup compile error, but the script exits 0 as if nothing happened.

I will fix this...

[trusktr]

Ok, now that I could debug it (PR #1192), I found out that adding the export words in src/core/index.js causes Rollup to complain You must supply "output.name" for IIFE bundles.

Let me see here...

[trusktr]

Nice. All checks have passed. What I could do though, is remove the config function stuff, and just make this a pull requests that adds the test updates, then make a new minimal PR just for the config function. Let me know if that's what I should do.

EDIT: The PR is not that big anyways. Turning on the Hide whitespace changes option makes a couple parts easier to read.

[trusktr]

@jhildenbiddle @sy-records @Koooooo-7 Can I get one more review from one of you on this?

[anikethsaha]

LGTM

[sy-records]

👍🏻

[Koooooo-7]

I learned from it. 🚀

[anikethsaha]

@trusktr feel free to fix the merge conflict and merge this.

[trusktr]

Yay. Ok tonight or tomorrow I'll fix the conflict and merge.

[trusktr]

I fixed the conflict with package-lock.json, and also I opened #1216 which should prevent conflicts from package-lock.

Also the e2e test failed. It is flaky. There's a race condition. I'll take a look soon. Let me re-run the tests...

[trusktr]

tests passed. Merging!