All my changes (don't merge)

[trusktr]

I'm just opening this to start some discussions. This PR has all the changes I made for my fork of Docsify to get my documentation project online with needed functionality.

The plan is that I'll make other pull requests with individual changes (with nice commit messages).

Make pull requests for

• docsify config function (PR: Allow configs to be functions #1189)
• prevent Docsify from erroneously handling links that are already in Docsify's format (see this line)
• Add a CSS class to Docsify-handled anchors tags to make it easier for Docsify users to identify Docsify-handled anchors. (this line, but move it into core)
• prevent scripts from being executed twice (see here)
  • Make sure to take Dynamic content in Vue components #1074 into consideration while making this change.

[trusktr]

I've got a lot of conflicts. :D

[trusktr]

I'll close this so it doesn't distract from valid pull requests, but we can still discuss.

[trusktr]

not sure why I deleted this file. Maybe I had differing VS Code settings. Personally I don't like to commit IDE files. I'd rather commit config files for tools like prettier, eslint, etc, that everyone must use regardless of IDE; developers should configure their IDE to use the tools (most modern IDEs support most of the common tools).

[anikethsaha]

yeah, no need to commit this. we can remove this file

[trusktr]

As the comment says, this prevents Docsify from erroneously handling links that are already in Docsify's format. This makes it easy to link to known pages if you already know the URL you want to link to. I think this is related to the next comment.

[trusktr]

I don't remember why I needed this. I'll report back after some investigation.

[trusktr]

I needed a way in my own code to detect Docsify links. The reason is that I have a custom html() hook to modify the markdown rendering and needed to skip links that are already handled by Docisfy:

This is my html hook:

			markdown: {
				// `this` in the following hooks is an instace of Marked Renderer
				renderer: {
					html(html) {
						const matches = html.matchAll(reAnchorWithHref)

						const {linkTarget, router} = vm.compiler

						// if we find an anchor tag with an href attribute
						for (const match of matches) {
							// if the link is a Docsify link generated from markdown, skip it, it is already handled
							if (match[0].startsWith('<a docsify-link')) continue // <--------------------- HERE

							// the result will be one of the three capturing groups from the regex
							let href = match[1] || match[2] || match[3]

							const originalHref = href

							// the first two capturing groups catch single or double quoted values
							const hasQuotes = !!(match[1] || match[2])

							// based on Docsify's Compiler._initRenderer() logic for the markdown "link" hook {{{

							// TODO make some syntax for telling it to ignore the compiling the href
							const ignoreLink = false

							if (
								!Docsify.util.isAbsolutePath(href) &&
								!vm.compiler._matchNotCompileLink(href) &&
								!ignoreLink &&
								// skip hrefs like `#/page?id=section`, which
								// are already in the format Docsify compiles
								// hrefs to
								// TODO move this to router.toURL
								!href.trim().startsWith('#/')
							) {
								if (href === vm.compiler.config.homepage) {
									href = 'README'
								}
								href = router.toURL(href, null, router.getCurrentPath())
							}

							// }}}

							if (!hasQuotes) href = '"' + href + '"'

							html = html.replace(originalHref, href)
						}

						return html
					},

I need to think about if this is the best way to do what I wanted, but I don't remember what problem I needed to solve. I'll need to disable this and see how it breaks my links so I can remember. 😄

Some of the logic is duplicated from other code inside Docsify, which isn't ideal. Let me think of how it can be easier...

[anikethsaha]

for, this I think we can have a use case if we reshape this a little.

like mentioned here in this issue #1088 (comment)

[trusktr]

Note also this piece of code is where I needed the vm instance that was passed into the $docsify config when it is a function.

like mentioned here in this issue #1088 (comment)

Gotcha, so if it had that feature then I could detect the ID prefix, similar to what I did with the docsify-link attribute.

[trusktr]

The changes with getScript/executeScript prevents script tags from executing twice. The setTimeout isn't needed, at least as far as I can tell everything works for me fine.

Maybe it was a hack to defer script execution to later so that things in the DOM are ready? If that's the case, users can for example use jQuery.ready() like normal (or etc).

[anikethsaha]

I think it will effect the custom scrip option which are defined in the markdown right ?

[trusktr]

custom scrip option which are defined in the markdown right

Can you expand on this?