Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't override existing index files #90

Closed
paulbrimicombe opened this issue Jan 19, 2024 · 4 comments
Closed

Don't override existing index files #90

paulbrimicombe opened this issue Jan 19, 2024 · 4 comments

Comments

@paulbrimicombe
Copy link
Contributor

Problem

  • All index files are generated automatically, even if the user has supplied an index.md file in their repository
  • This prevents users from defining their own top-level landing page / controlling the end-user's navigation through the site

Solution

  • If an index.html file has already been created for a given folder, don't override it with a generated one.

e.g. Ideally this page: https://broxy.tools.bbc.co.uk/morty-docs/fabl/ would actually look like this: https://broxy.tools.bbc.co.uk/morty-docs/fabl/README.html

@stephegn
Copy link
Contributor

Heya @paulbrimicombe!
While this does expand the functionality of morty-docs a bit we think this change makes sense - the current behaviour certainly seems wrong.

We are happy to include this without a flag but it probably needs a note in the README. I'll also raise an issue for the docs on our internal system.

@paulbrimicombe
Copy link
Contributor Author

Thanks @stephegn, I'll add a note in the README describing the new behaviour.

@paulbrimicombe
Copy link
Contributor Author

@stephegn I've added a quick note to the README about index file generation in the PR...

@stephegn
Copy link
Contributor

Fixed by #91

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants