docsify icon indicating copy to clipboard operation
docsify copied to clipboard

Config option to change the default landing page for a route from README.md

Open lysdexic-audio opened this issue 3 years ago • 1 comments

Feature request

Config option to change the default landing page for a route from README.md

What problem does this feature solve?

Allow users to pick a more suitable default index name like index.md

What does the proposed API look like?

<script>
    window.$docsify = {
      name: 'My Awesome Docsify',
      repo: '',
      routerDefaultLandingPage: 'index.md'
      ...
    }
</script>

How should this be implemented in your opinion?

Override existing implementation that uses README.md

Are you willing to work on this yourself?

Sure

lysdexic-audio avatar Aug 17 '22 04:08 lysdexic-audio

I think this is a good idea, although I think we might find a better name.

Nite, if you were to change it from README.md, then sites like GitHub will not know what file to display by default when browsing in a repo.

trusktr avatar Aug 17 '22 04:08 trusktr