objectivehtml / FlipClock

http://flipclockjs.com/
MIT License
2.74k stars 954 forks source link

Documentation: scaling and centering #378

Open ajmas opened 5 years ago

ajmas commented 5 years ago

While I did see separate issue entries for scaling (#54, #287 0.8.0) and centering (#228, #172) FlipClock, it would be god to have a specific documentation and example for this.

If there isn't a good place, maybe starting a FAQ section with this?

Though having played around with the CSS, it may be an idea to restructure the HTML to make this easier to control, since the suggested methods aren't consistent. Ideally the FlipClock should naturally be centered in its container, rather than being left aligned.

Have been using version 0.8.0.

pynner commented 5 years ago

@ajmas do you have a consistent solution for centering it in its container?

ajmas commented 5 years ago

The best I have is proposed in #379, but was hoping this would be thought about as part of the design.

brianespinosa commented 5 years ago

@ajmas give the js-es6 branch a try. Those styles and structure are a complete rewrite and the clock is responsive.

ajmas commented 5 years ago

Thanks for the info. When is this branch planned to be made into a release?

brianespinosa commented 5 years ago

@ajmas not sure. Both myself and @objectivehtml have been pretty slammed for some time.

I don't think we even have any proper documentation yet for the rewrite. We will probably need to put together a new site for it.

objectivehtml commented 5 years ago

Update on this thread:

I just had a chance to finally finish the new docs, which are now generated with jsdoc and can be contributed to with pull requests. The repo docs will get deployed to the server. The examples are now in the docs. I have a few more things to add, but this was the last step left to getting this released. I am going to deploy and merge to master within a couple of days. I just have to migrate the flipclockjs.com to a new server and setup deployments.

objectivehtml commented 5 years ago

If you download the repo and go to public/index.html you will see the new website. What's really great about this new architecture is the docs are now open source and welcome contributions.

https://github.com/objectivehtml/FlipClock/blob/js-es6/public/index.html