Skip to content

🌟Help us feature more Docusaurus v1 users! #1080

Description

@yangshun

Tip: This is a beginner level Docusaurus task that requires almost no coding and is more targeted at newcomers to the project and Open Source.

📚 Documentation

We want to feature more Docusaurus users and we need your help!

Docusaurus has a users page where we showcase projects using Docusaurus. This has the benefits of giving projects recognition and also lets the community and new users reference the creative ways of using Docusaurus. For example, Babel implemented the "copy code" button which we copied into our code, Reason has a full-width doc page and Prettier has a playground.

Here's a list of projects that we want to feature, in no particular order.

The process of adding users goes like this:

  1. Comment below with the project you're interested in helping and make sure it's not already claimed.
  2. Check if the project has a logo. If it doesn't have a logo, we could ask them to create one. If not, then we can't feature it as we don't have a way to feature projects without logos at the moment. Sorry about that.
  3. Make an issue on the GitHub project, asking about featuring their project on Docusaurus (most people would be okay with that).
  4. Get a reasonable-sized version of their logo (SVG preferred) and add it to website-1.x/static/img/users/<project-name-in-lower-snake-case>.{svg/png/jpg} not exceeding 512x512. Look into their website directory or project directory for the logo image file. Try to compress the logo first if possible using Photoshop or some online tools.
  5. Modify website-1.x/data/users.js and add the project into the JS file, sorted alphabetically by caption:
{
  caption: 'The Project Name',
  image: '/path/to/image',
  infoLink: 'www.example.com', // Website. Can be GitHub repo URL if website doesn't exist
  fbOpenSource: false,
  pinned: false,
},
  1. Run the Docusaurus website locally and see that the users page loads fine and shows the new user!
  2. Run yarn lint and yarn prettier before submitting the PR.
  3. Use the PR title - docs: showcase user <project name>.
  4. In the PR summary, add a link to the PR where you've asked the project for permissions to include their logo
  5. Submit your PR!

Have you read the Contributing Guidelines on issues?

Yes

Metadata

Metadata

Assignees

No one assigned

    Labels

    difficulty: starterIssues that are starter difficulty level, e.g. minimal tweaking with a clear test plan.good first issueIf you are just getting started with Docusaurus, this issue should be a good place to begin.help wantedAsking for outside help and/or contributions to this particular issue or PR.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions