docsify 4.x roadmap

[timaschew]

@docsifyjs/core
Before releasing 5.0 we should improve on some topics.

v4.x

This list is open for discussion.

• Agree to drop IE 10 support. Support is only available for IE 11
• Remove lib directory from version control
• find bugs which should be fixed before 5.0 and attach 4.x milestone to them
• fix selected bugs
• improve test coverage
• setup browser testing (cypress for instance) ( [WIP] test(e2e): added jest env and puppeteer for e2e #986 )
• Closing docsify 5.0 roadmap #657 and create a new one (since it becomes a bit messy)
• fixing Lint errors and warning ( Eslint fixes for the project #987 )

Related discussions:
#657 (comment)

---

5.0 and further:

• use docsify-themeable as default theme
• Feat/5.0 #802
  • Static generation
  • New Markdown Syntax
• Drop-in-replacement for GitBook

[jhildenbiddle]

Thanks for taking this on, @timaschew. My plate is pretty full at the moment, but I'm happy to help out on specific areas upon request. Once more time becomes available, I can be more proactive about contributing. Until then, just let me know if/when you can use a hand.

[jrappen]

Using the service worker example from the docs, docsify now loads docs for the current translation only. This is possibly related to search only working for the current translation only as well (which was completely broken a short while back as discussed in jhildenbiddle/docsify-themeable#18 and worked across translations before that). Is there any reason for this?

[anikethsaha]

Additional Proposal v5

1. New Markdown Parser (probably markdown-it)

New Markdown Syntax

For new markdown syntax, I would recommend using a pluggable markdown processor which can be configured using the docsify config, like markdown-it

2. Better executable code syntax in MD

Problem

This is with reference to executeScript property. Currently, docsify checking an executable script tag using this
The markdown input for these doesn't look good ref

solution

if we are moving with pluggable markdown parser then create a plugin ( or use if exists ) to add custom syntax to uniquely identify some pre-coded syntax which can be replaced in the renderer.

Repo Management

1. Snyk bot and dependent bot

As we use markdown parser, there are often security alerts come up for them and it is required to keep up with the dependencies up-to-date. Adding a dependency updating bot might help here

2. Separate Repo for docs site ( Not required )

In order to keep up with fixed and updated content. We can move the website code to a separate branch.

3. Adding funding button ( Done )

This need not have to wait until v5. can be done anytime.

4. Stale bot

To help in managing old issues

cc @docsifyjs/core

[anikethsaha]

@timaschew I am closing this in favor of #1061

Please let me know if you think something more/less needs to be added in #1061