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

Doco Serve showing root folder directory instead of actual doco on build. #10

Open
Axodouble opened this issue Feb 4, 2024 · 5 comments
Assignees

Comments

@Axodouble
Copy link

Running doco serve seems to only show a preview of the root folder directory instead of what it shows on github pages.
7916e3

@Axodouble
Copy link
Author

  • No errors in log:
2024/02/04 21:35:16 > Serving documentation on http://localhost:3000/
2024/02/04 21:35:16 > 👀 Watching for changes in docs

@paganotoni
Copy link
Owner

paganotoni commented Feb 4, 2024

Thanks, @Axodouble. For reporting this, it happens because there is no index.md in your docs folder; hence, no index.html is generated. This file is generated with doco init. That said, I need to tweak a couple of things after reading this case; thanks for sharing it!

@paganotoni
Copy link
Owner

paganotoni commented Feb 4, 2024

@Axodouble As a fix, you could manually add docs/index.md. That should make doco serve index.html instead of the folder. I will keep you posted regarding any improvement in this behavior. Thanks again.

@paganotoni paganotoni self-assigned this Feb 4, 2024
@Axodouble
Copy link
Author

Looks good, I will update the issue once I get a chance to test this.

@Axodouble
Copy link
Author

There is now an index.md file in the docs folder, however same behavior still persists.

Possibly important information however is that the docs folder is a child in the folder the command is being executed in, when changing the address to http://localhost:3000/docs/ it does work, however manually executing the same command in the docs folder causes the following in the log:

2024/02/05 19:06:07 > Serving documentation on http://localhost:3000/
2024/02/05 19:06:07 > 👀 Watching for changes in docs
2024/02/05 19:06:07 CreateFile docs: The system cannot find the file specified.

Hope this specifies some things.

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