processing / processing-pi-website

Files for the pi.processing.org subdomain that documents Processing on the Raspberry Pi
https://pi.processing.org/
16 stars 10 forks source link

Local reference? #4

Open gohai opened 6 years ago

gohai commented 6 years ago

The new site seems to miss half of the content (i.e. the stuff that was on the right).

Is a two-column layout for this page feasible with our hugo theme?

msurguy commented 6 years ago

@gohai I've been researching this and here are our options:

We then need to use Kube's CSS row and col helpers for assigning column widths: https://imperavi.com/kube/docs/grid/ or https://imperavi.com/kube/docs/sizing/

gohai commented 6 years ago

I've added the missing content for now: 1c5a410e2e8f65e519f5e1724a393fa77e0f671f

@msurguy Perhaps some custom CSS that is only selected for that particular post? I don't think we'd need to use the two-column layout more often. Thinking that ideally, the content would be two-column if there there page is wide enough, and if not breaks down to a single one. CSS Columns perhaps?

Tiny question: Any benefit of having the actual link targets as references at the bottom of the page? (Haven't seen this before)

Thanks!

msurguy commented 6 years ago

@gohai here's a bit more background on the link targets being all grouped on the bottom of the markdown file: it was a side effect of me converting HTML -> MD through an online tool that for some reason thought of these as references. Basically it's ok to use regular links instead but let's hold off on that and get back to it after we decide on the following.

Thinking about this section of the site a little more, I am leaning towards splitting the page into several MD subpages that can populate the reference page automatically. Consider this directory structure:

- reference/
   - _index.md (loops through all pages's MD content and compiles one page automatically)
   - I2C.md
   - GPIO.md
   - LED.md
   - PWM.md
   - SPI.md
   - ...

This would give us greater flexibility and ability to display more content about each of these topics on their dedicated pages, along with automated index page generation.

Let me know what you think about this proposal!

gohai commented 6 years ago

@msurguy Is the suggestion to bring in all the content that is currently here?