gulpjs / gulpjs.github.io

The gulp website
http://gulpjs.com
44 stars 44 forks source link

Docusaurus theme for the gulp website #31

Closed phated closed 6 years ago

phated commented 8 years ago

Hey website team! We are in need of a GitBook theme for the documentation refresh. More information at https://github.com/gulpjs/gulp/issues/1595

Anyone available to tackle this?

matchai commented 8 years ago

If I were to take on this issue, should I assume that #11 has been abandoned? If a website redesign is around the corner, the theme should match the design of the upcoming site.

phated commented 8 years ago

I think that it falls into one of the items in that issue but I think the gulp red is so iconic that the website shouldn't stray from it. The documentation will be gitbook and hosted on our domain, which is why we are in need of a custom theme. Hope that helps.

phated commented 7 years ago

We might want to use https://github.com/GitbookIO/theme-api as a base.

yocontra commented 7 years ago

@matchai New site is up, same colors and fonts so no changes gitbook-wise.

ansballard commented 7 years ago

So as far as I can tell there's no current dev on this issue, is there anything I'm not seeing or can I try to dive in?

yocontra commented 7 years ago

@ansballard Go for it, don't think anyone is touching it right now

phated commented 7 years ago

There's nothing. I think we want to work on the theme in a branch on this repo (once it's completed, we can figure out if we want to move it).

ansballard commented 7 years ago

Just a quick update. Had a few free hours yesterday so I got most of the way through a gitbook plugin that can pull down the README.md from https://github.com/isaacs/node-glob and split it out by any level headers. Haven't gotten to the point where I can inject the content from any section, but it looks pretty close, barring edge cases.

phated commented 7 years ago

@ansballard cool. That's not quite the theme but something we will be looking for (there's another issue open on the main repo for it).

ansballard commented 7 years ago

Oops, that's my bad, I thought the plugin fell under the theme. I'll post progress from here on in the main repo and get back here when I can get to the theme. But just to be clear, no progress on the actual theme as of yet, in case anyone else is watching for something to work on.

Saturate commented 7 years ago

Any work done on this yet? If not and I might throw my self at it.

ansballard commented 7 years ago

Nope, it's all you. I've been swamped with life so I haven't been able to get to it.

phated commented 7 years ago

@Saturate no work at all has been done (I did some initial research that I posted in the comments above). It'd be awesome if you want to tackle this.

Saturate commented 7 years ago

Great, I'll look at it soonish when I have some free time.

It is correct that we want the GitBook docs to live here, and pull in content from the other repos?

phated commented 7 years ago

@Saturate my current thinking is that the theme and output will exist here and there will be some process to pull the markdown files from the main repository (don't worry about this part right now).

Saturate commented 7 years ago

Just a quick update, I did a lot of work with GitBook on my other (paid) projects. But haven't started on this issue yet, time is a constraint here, like all of us know :-)

But it's not forgotten, and after I'm settled in, I'll look at it (Just moved to Copenhagen).

phated commented 7 years ago

@Saturate No worries. Documentation won't be a focus until the after the soft launch. Though, we're definitely looking forward to your theme!

phated commented 6 years ago

@SomethingNew71 no one is working on it afaik, so feel free to work on it. The current assumption is that the theme will live here and the gitbook will be generated from whatever documentation is gulp's main docs/ directory.

phated commented 6 years ago

@SomethingNew71 still planning to work on this?

phated commented 6 years ago

Perfect, thanks! Ping me if you need anything, I plan to work on docs stuff this week.

phated commented 6 years ago

@SomethingNew71 we'll do our own hosting from this repo (a docs/ folder makes sense) - btw, I'm super excited to have you working on this!

phated commented 6 years ago

Completed by #78 - awesome work @SomethingNew71