search

facebook / docusaurus

Easy to maintain open source documentation websites.
https://docusaurus.io
MIT License
55.96k stars 8.4k forks source link

No branded docusaurus-init #1196

Closed JoelMarcey closed 3 years ago

JoelMarcey commented 5 years ago

🚀 Feature

A no-branded, totally vanilla docusaurus-init

Have you read the Contributing Guidelines on issues?

Yes

Motivation

via @jordwalke

Pitch

Have a version of docusaurus-init that does not include any logos, images, etc. Just vanilla.

Could be run like docusaurus-init --no-brand or something.

kyldvs commented 5 years ago

I just ran into this too, was hard to make sure I found and removed all the branding. I think I still use a css class prefixed with fb in the footer I couldn't find to rename.

ahmadalfy commented 5 years ago

Can someone clarify what's the hackathon tag? should contributors avoid doing efforts on it?

JoelMarcey commented 5 years ago

@ahmadalfy Hi - please feel free to do work on those with the hackathon tag. Actually, let me remove it now. It was for a quick hackathon last week.

ahtee commented 5 years ago

@kyldvs mentioned that it took a while to remove all branding, and this is a no-branding discussion, but what if there was a central place where you could change the branding everwhere if you did have a brand? and if that field is empty or null then it removes all branding from the template..?

alexieyizhe commented 4 years ago

@endiliey is anyone working on this? if not, I'd love to give it a shot 👍

endiliey commented 4 years ago

cc @yangshun

Sent from my iPhone

On 8 Oct 2019, at 12:37 PM, Alex Xie notifications@github.com wrote:

@endiliey is anyone working on this? if not, I'd love to give it a shot 👍

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

fanny commented 4 years ago

@yangshun I think that would be a good way to explore more the plugins config. What do you think?

leeyspaul commented 3 years ago

Reviving an old thread. What constitutes vanilla? I was browsing around and starting with init gave me a few reference to docusarus but not a lot. Thank you for the context in advance. :]

@JoelMarcey

slorber commented 3 years ago

Not sure exactly either what should be done, but it looks related to https://github.com/facebook/docusaurus/issues/3489

leeyspaul commented 3 years ago

Yeah, it seems like #3489 is about splitting up the base template into a series of templates for different use cases. So this vanilla template would be the base perhaps.

I think the maintenance factor is a valid concern too. Definitely still seems like an open and ongoing discussion. @fanny might have some creative ideas!

slorber commented 3 years ago

I'm considering that this issue is v1

v2 now has a classic template with no Facebook branding, and has a separate template for Facebook projects.

Considering the classic template as the "vanilla" template, but I'm not 100% sure to understand what vanilla means exactly here. v2 users don't complain much about having to remote existing branding.

The Docusaurus team is actively working on Docusaurus v2.

After a very long alpha, Docusaurus v2 is now in beta. We believe that the v2 beta is already better than v1, and v2 is ready for maintstream adoption.

Apart from critical issues and security fixes, we don't plan to invest much time on Docusaurus v1 anymore.

We are all closing v1 issues. Maybe the current issue is already fixed in Docusaurus v2. Please try to upgrade, and if the issue is still there on Docusaurus v2, open a new issue.