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

Use Jekyll to generate site #3

Merged
merged 2 commits into from
Jul 6, 2020
Merged

Conversation

cmfcmf
Copy link
Member

@cmfcmf cmfcmf commented Jul 5, 2020

This PR introduces Jekyll to generate the documentation site.
Jekyll is automatically used by GitHub pages - no additional build step is required.

  • The page is now responsive and minimal responsive with pure.css #2 should no longer be needed.
  • Obviously the Padauk SDCC Tutorial page is still empty - but it seems like a good place to start.
  • I did not link to any of the SDCC examples and header repositories, because their structure is not yet clear.
  • I kept the old pinout diagrams of the PMS154 for now.

image


image


image

@cpldcpu
Copy link
Member

cpldcpu commented Jul 6, 2020

Awesome! I guess I need to install jykell locally to check this out before deployment. Will look into this asap.

@cmfcmf
Copy link
Member Author

cmfcmf commented Jul 6, 2020

I guess I need to install jykell locally to check this out before deployment. Will look into this asap.

We could setup a service like netlify to automatically build previews of the site for pull requests. I've enabled it on my fork for testing purposes, and it appears to work fine. Here is an example pull request with a link to a preview site: cmfcmf#1

image

https://deploy-preview-1--reverent-sinoussi-f065ff.netlify.app/

@cpldcpu cpldcpu changed the base branch from master to development July 6, 2020 12:48
@cpldcpu
Copy link
Member

cpldcpu commented Jul 6, 2020

That looks great, need to check it out. Btw - I created a development branch and changed this pull request to the new branch.

@cpldcpu cpldcpu requested review from cpldcpu and freepdk July 6, 2020 14:25
Copy link
Contributor

@freepdk freepdk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. Keep going :-)

Copy link
Member

@cpldcpu cpldcpu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The header/footer on the page for the individual devices seems to be huge! There is only about a third of the page for content. Would it make sense to change this to fixed layout that always displays the full pinout information?

grafik

- [F series MTP](http://www.padauk.com.tw/en/product/index.aspx?kind=42) (MTP = *multiple time programmable*)

Padauk µCs are extremely cheap (as cheap as $0.03 per µC), which is why
David from the EEVblog made the [first video](https://youtu.be/VYhAGnsnO7w)
Copy link
Member

@cpldcpu cpldcpu Jul 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

He is actually named "Dave" :)

@cpldcpu cpldcpu merged commit 8d5048b into free-pdk:development Jul 6, 2020
@cpldcpu
Copy link
Member

cpldcpu commented Jul 6, 2020

anyways - pushing this as it is definitely a huge leap over the current state. Can add more changes later.

@cmfcmf
Copy link
Member Author

cmfcmf commented Jul 6, 2020

The header/footer on the page for the individual devices seems to be huge! There is only about a third of the page for content. Would it make sense to change this to fixed layout that always displays the full pinout information?

You're right. I initially restricted the height of the pinout diagrams so that a potential detailed description of the µC would not be too far down the page. I opened #7 to instead move potential descriptions above the pinout diagrams and removed the height restriction on them.

He is actually named "Dave" :)

🙈

@cmfcmf cmfcmf deleted the jekyll branch July 8, 2020 20:35
@cmfcmf cmfcmf mentioned this pull request Jul 9, 2020
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

Successfully merging this pull request may close these issues.

3 participants