slatedocs / slate

Beautiful static documentation for your API
https://slatedocs.github.io/slate
Apache License 2.0
36.06k stars 159 forks source link

Question: two-column format? #643

Closed jcw closed 7 years ago

jcw commented 7 years ago

Starting off w/ Slate for the first time, I'm wondering: is there simple/std way to disable 3-column format and go to 2-column w/ code snippets inline? Reason: I'm used to have the browser on half a screen, i.e. 960px wide, which makes things a bit crowded with the default format. The snippets won't be that large for the docs I'm writing.

Apologies if this is a FAQ, but a first search in the wiki and issues didn't lead to any hints.

-jcw

lord commented 7 years ago

No worries! Does changing this variable to be a larger value fix your problem?

pnerger commented 7 years ago

If you look at my fork, there is a variable that you can set in the YAML directives at the top that pullls in a different CSS to provide a two column format with code snippets in-line.

It has a lot of other changes that you're probably not interested in but if you look at the layout template, you'll see how the CSS is used to get two columns.

Paul

https://github.com/pnerger/dpSlate

jcw commented 7 years ago

@lord - Ah, very nice, thx: it snaps into two columns when set to 958 (MacOS, Safari, using Moom). @pnerger - That was indeed exactly the other part of my question - thanks for the link.

You guys rock.

jcw commented 7 years ago

Whoops - closed this issue just a tad too quickly, I'm afraid...

When trying out dpSlate, I get errors which seem to prevent middleman from serving requests:

Expected string default value for '--instrument'; got false (boolean)
Expected string default value for '--reload-paths'; got false (boolean)
Expected string default value for '--instrument'; got false (boolean)

This was after the bundle install. I did find the rightPanel setting in source/_defaults.yml.

lord commented 7 years ago

(I'm going to close this since we don't support other forks, but feel free to continue discussion here if you'd like.)

jcw commented 7 years ago

Understand - I didn't find another way to report this to @pnerger but it's not an issue for this repo.