search

mpetrovich / stylemark

Generate interactive style guides from Markdown.
MIT License
218 stars 35 forks source link

underscore folder problem with github pages #65

Closed ghost closed 5 years ago

ghost commented 5 years ago

The stylemark folder starting with an underscore cause problem with github pages.

Files in that folder aren't loaded when you use github pages for you documentation.

stefankunze commented 5 years ago

Simply add a .nojekyll file in the styleguide directory. This will solve your issue.

github blogpost

ghost commented 5 years ago

Fixed with .nojekyll file, thank you !

kbradley commented 4 years ago

I had the same issue and tried adding a .nojekyll file both to the root of my Github pages repo and also within the "docs" folder where I output stylemark files for my project. Neither has worked and I get 404s on my github page for all the files in the "_stylemark" directory.

Would it be possible just to rename the directory to "stylemark" without the underscore so that all this isn't necessary to begin with?

(I experimented with manually renaming the directory and references to it which worked but isn't a good long term solution...)

kbradley commented 4 years ago

I wrote the above too soon. GIthub finally recognized the file and my Stylemark github page is finally working. This was a big headache to discover the cause and how to fix though so respectfully I'd still like to request the directory be renamed if possible to help others avoid this issue in the future. Thanks.