Fonder-docs

This website is built using Docusaurus, a modern static website generator.

Installation

nvm use && yarn

Local Development

yarn dev

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

yarn build

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

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

🤝 Contributing

We welcome contributions! Here's how you can help:

Getting Started

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes
4. Run tests: yarn test
5. Submit a pull request

Types of Contributions

• 🐛 Bug fixes
• ✨ New features
• 📚 Documentation improvements
• 🌍 Translations
• 🧪 Test improvements

Code Style

• Follow the existing code style
• Add comments for complex logic
• Update documentation for changes
• Add tests for new features