---

[INSERT PROJECT NAME] Website

Website and Docs for [INSERT PROJECT NAME].

[INSERT YOUR BADGES HERE (SEE: https://shields.io)]

[INSERT SCREENSHOT OF YOUR SOFTWARE, IF APPLICABLE]

[INSERT PROJECT NAME] hosts a website built with Docusaurus, a site generator that is optimized for building documentation websites. It was created to help you quickly and easily set up a website for your project, including comprehensive documentation and other static content.

[INSERT LIST OF IMPORTANT PROJECT / REPO LINKS HERE]

Features

• Simple and efficient setup with Docusaurus
• Live-reloading development server for quick feedback
• Easy deployment to GitHub Pages
• Customizable to fit your project’s branding and needs

Contents

• Features
• Contents
• Quick Start
  • Requirements
  • Setup Instructions
  • Run Instructions
  • Build Instructions
  • Deployment
• Changelog
• Frequently Asked Questions (FAQ)
• Contributing
• License
• Support

Quick Start

This guide provides a quick way to get started with our project. Please see our [docs]([INSERT LINK TO DOCS SITE / WIKI HERE]) for a more comprehensive overview.

Requirements

• Node.js and npm installed on your machine
• Yarn package manager

Setup Instructions

1. Clone the repository to your local machine.
2. Install the dependencies:

yarn

Run Instructions

1. Start the local development server:

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build Instructions

1. Build the static content:

yarn build

This command generates static content into the build directory and can be served using any static content hosting service.

Deployment

The project is configured to automatically build and deploy using GitHub Actions. The workflow files located within the .github/workflows directory are set up to trigger builds whenever commits are pushed to the main branch. Additionally, pull requests will be automatically built for testing purposes.

To ensure your site is properly deployed:

1. Ensure that GitHub Pages is enabled for your repository. You can enable it by going to the repository settings on GitHub and selecting the branch you want to use for GitHub Pages, typically gh-pages or main.

2. If you prefer manual deployment or are not using GitHub Actions, you can still deploy manually:

   • Deploy using SSH:

     USE_SSH=true yarn deploy
     

   • Deploy without SSH:

     GIT_USER=<Your GitHub username> yarn deploy
     

3. For more detailed information on deploying with GitHub Actions, please refer to the Docusaurus documentation.

By following these steps, your site will be automatically built and deployed when changes are made to the main branch or when pull requests are created. Manual deployment commands are also available if needed.

Changelog

See our CHANGELOG.md for a history of our changes.

See our [releases page]([INSERT LINK TO YOUR RELEASES PAGE]) for our key versioned releases.

Frequently Asked Questions (FAQ)

[INSERT LINK TO FAQ PAGE OR PROVIDE FAQ INLINE HERE]

Contributing

[INSERT LINK TO CONTRIBUTING GUIDE OR FILL INLINE HERE]

[INSERT LINK TO YOUR CODE_OF_CONDUCT.md OR SHARE TEXT HERE]

[INSERT LINK TO YOUR GOVERNANCE.md OR SHARE TEXT HERE]

License

See our: LICENSE

Support

[INSERT CONTACT INFORMATION OR PROFILE LINKS TO MAINTAINERS AMONG COMMITTER LIST]