Skip to content

Latest commit

 

History

History
178 lines (117 loc) · 9.37 KB

README.md

File metadata and controls

178 lines (117 loc) · 9.37 KB

Docusaurus

Docusaurus

IMPORTANT: You can submit your token to our showcase by posting in this discussion. However, we cannot guarantee that your token will be added, nor how quickly it will be added. Please be patient.

Add your token to the solana showcase 🧑‍🎨You built a beautiful solana token and want to show it to the world?

🙏 Add it to our website showcase — it only takes seconds! ⏱

✒️The only thing you have to do is ➡️ give us your approval!

⚠️ Submit your website only.

Submit your token Just post a comment in this GitHub discussion with some basic information:

Token title: <= 60 characters Token description: ≤120 characters Token URL: Live production deployment URL of your website Token CA: Token address Tags: See the list of available tags below You can also just give us the website URL and we’ll figure out the rest, but providing additional information is still appreciated and ensures the correct information is displayed 😄.

We will take screenshots of the tokens ourselves.

This data will be used to render the site showcase card:

Site showcase card example

After submission We will add your token as soon as possible.

Please wait - we will reply later to avoid creating too many notifications for everyone. If the notifications bother you, you can still unsubscribe - we will ping you when you reply.

We will add valid submissions to our site showcase in one go when we have time.

We will notify you if your submission is invalid.

Site Tags List of available site tags:

Meme Airdrop FanToken Tokenization RWA NFT

Note Help us keep the showcase up to date: tell us when a token has bad data.

You can also request updates to the token showcase data!

Technically, you can open a PR yourself and edit website/src/data/users.tsx. However, except for very minor edits, we prefer to handle PRs ourselves for various reasons (signing Facebook CLA, too many PRs, time-consuming reviews, resizing images, fixing site tags and linter issues...) We reserve the right to edit your submission before publishing We will always keep this discussion clean: submissions will be marked as resolved and then deleted

Twitter Follow npm version GitHub Actions status PRs Welcome Discord Chat code style: prettier Tested with Jest Covered by Argos Gitpod Ready-to-Code Netlify Status Deploy with Vercel Deploy to Netlify

Introduction

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Short on time? Check out our 5-minute tutorial ⏱️!

Tip: use docusaurus.new to test Docusaurus immediately in a playground.

  • Simple to Start

Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.

  • Localizable

Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.

  • Customizable

While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.

Installation

Use the initialization CLI to create your site:

npm init docusaurus@latest

Read the docs for any further information.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner-friendly bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner-friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.

Contact

We have a few channels for contact:

  • Discord:
    • #general for those using Docusaurus.
    • #contributors for those wanting to contribute to the Docusaurus core.
  • @docusaurus X (Twitter)
  • GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 Become a backer

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.

Special thanks

BrowserStack logo

BrowserStack supports us with free access for open source.

Rocket Validator logo

Rocket Validator helps us find HTML markup or accessibility issues.