scott3j / docusaurus-2

Hi there 👋

docusaurus-2's Issues

sweep(slow): determine what is causing the deployment error in this repo and fix the problem

Checklist

• docusaurus.config.js

• Ensure that all the settings in this file are correctly configured for the deployment environment. Correct any misconfigurations found.
• Check that all the paths specified in the settings are correct and exist in the repository.

• package.json

• Check the build and deployment scripts in this file. Ensure that all the dependencies are correctly installed and the scripts are working as expected.
• If any scripts are not working as expected, correct them.

• custom_deployment_script.js

• If there are any custom deployment scripts in the repository, check that they are correctly integrated with the build and deployment process.
• If they are not correctly integrated, correct the integration.

• deployment_logs.txt

• If the issue persists, check the logs for any error messages during the deployment process.
• Record these error messages in this file for further analysis.

sweep: Add a banner at the top asking the user to star the docusaurus repo with the current number of stars

Use shields.io and make sure this is at the very top of the repo. Make sure it's aesthetic, centered and set the background color of the banner to lime.

Checklist

• src/components/GithubStarsBanner.js

• Import React and necessary Docusaurus components
• Create a new React component named GithubStarsBanner
• In the component, fetch the star count from GitHub using the GitHub API
• Render a banner with the star count and a message asking users to star the Docusaurus repository
• Style the banner with a lime background and center alignment

• src/components/GithubStarsBanner.module.css

• Define CSS rules for the GithubStarsBanner component
• Set the background color to lime
• Center the text and adjust the padding and margins for aesthetic design

• src/pages/index.js

• Import the GithubStarsBanner component
• Add the GithubStarsBanner component at the top of the main layout

Checklist

• src/components/GithubStarsBanner.js

• Create a new React component named GithubStarsBanner.
• Use the fetch function to make a GET request to the GitHub API at https://api.github.com/repos/facebook/docusaurus.
• Use the useState and useEffect hooks from React to fetch the star count from the GitHub API when the component mounts, and store the star count in the state.
• Render a banner with the star count and a message asking users to star the Docusaurus repository.
• Use the Link component from Docusaurus to link to the Docusaurus repository on GitHub. The text of the link should be "Star us on GitHub".
• Use the clsx function to apply CSS classes to the banner. The CSS classes should be defined in src/components/GithubStarsBanner.module.css.

• src/components/GithubStarsBanner.module.css

• Define CSS rules for the GithubStarsBanner component.
• Set the background color to lime using the background-color property.
• Center the text using the text-align property.
• Adjust the padding and margins for aesthetic design using the padding and margin properties.

• src/pages/index.js

• Import the GithubStarsBanner component using the import statement.
• Add the GithubStarsBanner component at the top of the return statement in the Home function. This will add the GithubStarsBanner component at the top of the main layout.

Sweep (slow): create a button on the homepage that is pink and says fart.

Details

No response

Checklist

• src/pages/index.js ✅ Commit 5d25807

• Add a new button element in the HomepageHeader function. The button should be placed after the existing Link element. The button should have the text 'fart'.
• Apply the class 'fartButton' to the new button. This class will be defined in the src/pages/index.module.css file.

• src/pages/index.module.css ✅ Commit 05a1963

• Add a new class 'fartButton'. This class should style the button to be pink. You can use the CSS property 'background-color' to set the color of the button.