royale-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Carlos Rovira <carlosrov...@apache.org>
Subject Re: Royale Documentation Page Layout Proposal
Date Fri, 26 Jan 2018 22:15:28 GMT
Hi Alex,

2018-01-26 21:40 GMT+01:00 Alex Harui <aharui@adobe.com.invalid>:

> Yes, looks great!  My only thought is whether the red background should
> just be a rectangle or may less height on the right so we can bring the
> first line of text up higher and save more screen space.  IOW, try to fit
> a few more lines of documentation on the screen.
>
>
Right, I use the actual background, but as well though in create one for
this. I'll give it a try.


> Also, what if the title is really long and starts to overrun the right
> side of the image?  I suppose we could try some fancy CSS bitmap operation.
>

I think that's not a problem, if the text is large it will continue in the
next line, and should look ok.

>
> One other thing that might need its own thread:  I don't know of a Jekyll
> way to get the ToC to be separately interactive where you can click on the
> expand/collapse graphics and the ToC will act like a Tree control.  There
> might be a way since I'm new to Jekyll.  We could replace the Jekyll
> generation of the ToC with a Royale app that manages the ToC if we need it
> to be interactive.  Right now everything is static.
>

I think this should me more easy since is widely used. We should
investigate and hope to find and easy way to create a tree navigation.
As well, I see github pages docs sites that in publication view gives a
link to the GitHub .md file to edit it.
So, in the end the docs should be as easy as so we can setup, edit and
publish in a blink of an eye.
We should find the right workflow and how to make a tree easily. Then
creating and editing should be quick for any of us.

A last thing to take into account is about get the right CSS styles for
code, and other things so .md will be stylized correctly.

I'll continue investigating

Thanks

Carlos




>
> Thanks,
> -Alex
>
> On 1/26/18, 12:23 PM, "Piotr Zarzycki" <piotrzarzycki21@gmail.com> wrote:
>
> >Cool!! :)
> >
> >2018-01-26 21:18 GMT+01:00 Carlos Rovira <carlosrovira@apache.org>:
> >
> >> Hi,
> >>
> >> I'm playing with this concept
> >>
> >>
> >>https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Froyale.c
> >>odeoscopic.com%2Fdocumentation-page-example%
> 2F&data=02%7C01%7Caharui%40ad
> >>obe.com%7Cf3e8feca0c3e404e43e308d564fab63d%
> 7Cfa7b1b5a7b34438794aed2c178de
> >>cee1%7C0%7C0%7C636525950328547739&sdata=vuv%
> 2BuNsHKOO28vssWcdy2TvL1XdxpTS
> >>floN8ozx1rMk%3D&reserved=0
> >>
> >> Here I use:
> >>
> >> * The website page header
> >> * Royale logo white use
> >> * There's an alternate menu to configure (main website, blog,
> >>GitHub,...)
> >> * Search for docs (important)
> >>
> >> In content:
> >>
> >> * Main page doc title
> >> * Main doc section content (demo content to show something)
> >>
> >> Navigation:
> >>
> >> * Menu colapasable (accordion type)
> >> * Only 2 level
> >> * Menu content has some of the items I saw here and there, but is
> >>completly
> >> demo
> >>
> >>
> >> let me know what do you think
> >>
> >> Thanks
> >>
> >> --
> >> Carlos Rovira
> >>
> >>https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fabout.me%
> >>2Fcarlosrovira&data=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e404e43e308
> >>d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C63652595032854773
> >>9&sdata=L0tB1P5SOatX1HpGHJ0F928hc2BNwbtg1OCeuXgo8gE%3D&reserved=0
> >>
> >
> >
> >
> >--
> >
> >Piotr Zarzycki
> >
> >Patreon:
> >*https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fwww.patr
> >eon.com%2Fpiotrzarzycki&data=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e40
> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C6365259503
> >28547739&sdata=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%
> 2Biz9y5mSSBRdhplVKk%3D&re
> >served=0
> ><https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fwww.patr
> >eon.com%2Fpiotrzarzycki&data=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e40
> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C6365259503
> >28547739&sdata=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%
> 2Biz9y5mSSBRdhplVKk%3D&re
> >served=0>*
>
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message