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

Documentation is not rendering nicely #76

Open
Miq1 opened this issue Feb 1, 2021 · 8 comments
Open

Documentation is not rendering nicely #76

Miq1 opened this issue Feb 1, 2021 · 8 comments

Comments

@Miq1
Copy link

Miq1 commented Feb 1, 2021

Unfortunately, the HTML docs are not rendered nicely - all I could achieve is opening single HTML files to read them one by one. Am I missing something?

Plus, a picture of the look of all fonts would be a nice addition.

@Miq1
Copy link
Author

Miq1 commented Feb 1, 2021

As a remedy, I found this tip on Stackoverflow. With it, the docs can be seen as

https://raw.githack.com/greiman/SSD1306Ascii/master/doc/html/class_s_s_d1306_ascii.html

@greiman
Copy link
Owner

greiman commented Feb 1, 2021

You can got to the docs folder and click on this file.

Arduino/libraries/SSD1306Ascii/doc/SSD1306Ascii.htm

It opens the correct index file. and is better than the above.

I will add this to the README.md file.

@Miq1
Copy link
Author

Miq1 commented Feb 1, 2021

No, that will only give me
grafik

@greiman
Copy link
Owner

greiman commented Feb 1, 2021

What browser are you using? If I open SSD1306Ascii.html with chrome, firefox, edge, or explorer, I get the correct result.

You must open this in the local copy of the library.

@Miq1
Copy link
Author

Miq1 commented Feb 1, 2021

Firefox 85.0 on Windows 10. The local copy is what I tried first, but then the page is lacking all decoration and pictures:
grafik

@Miq1
Copy link
Author

Miq1 commented Feb 1, 2021

Argh. My bad... 😊

I opened the file within the ZIP - after unpacking the structure into a proper directory tree it works out fine. Sorry for having bothered you!

@greiman
Copy link
Owner

greiman commented Feb 1, 2021

I should have known. I plan to zip the html in the doc folders all my libraries in the future since they obscure the source changes with hundreds of changed html files. I am already doing this in SdFat.

I am amazed it partially worked. I am putting a single html file in the html folder with instructions to unzip html.zip and it replaces the html folder.

@Miq1
Copy link
Author

Miq1 commented Feb 1, 2021

👍
Thanks a lot!

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