Skip to content

Local reference? #4

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

Open
gohai opened this issue May 30, 2018 · 4 comments
Open

Local reference? #4

gohai opened this issue May 30, 2018 · 4 comments
Assignees

Comments

@gohai
Copy link
Contributor

gohai commented May 30, 2018

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 msurguy self-assigned this May 30, 2018
@msurguy
Copy link
Collaborator

msurguy commented May 30, 2018

@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
Copy link
Contributor Author

gohai commented May 31, 2018

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

@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
Copy link
Collaborator

msurguy commented May 31, 2018

@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
Copy link
Contributor Author

gohai commented Jun 1, 2018

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

@gohai gohai changed the title Missing content in Reference Local reference? Jun 24, 2018
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