search

htl-leonding-college / asciidoctor-docker-template

A template project for creating doc-as-code with docker
https://htl-leonding-college.github.io/asciidoctor-docker-template/
14 stars 16 forks source link

Replace README.adoc with README.md #7

Closed stefnotch closed 4 years ago

stefnotch commented 4 years ago

Documenting more issues that I or other students have run into:

So, if you copy this repository into a docs folder, because you don't want to clutter up your root directory, GitHub pages won't work. That makes sense.

However, debugging this isn't as painless as it could be, because a README.adoc won't get shown at all! You'll end up with the following page instead of the README.md of this repository. And you will have no idea where you screwed up. image

stefnotch commented 4 years ago

For the record, if all paths in the documentation are relative paths, then it can be sorta fixed by adding an index.html.

<!DOCTYPE HTML>
<html lang="en-US">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="refresh" content="1;url=docs/index.html">
        <title>Page Redirection</title>
    </head>
    <body>
        If you are not redirected automatically, <a href="docs/index.html">click here</a>
    </body>
</html>
stefnotch commented 4 years ago

Fixed by https://github.com/htl-leonding-college/asciidoctor-docker-template/commit/dc60d1be6702f5bbf014fe3964a4f9b800051c6c#diff-04c6e90faac2675aa89e2176d2eec7d8