README.md

minimal but capable documentation template.

🌟 Introduction

HandyDocs is a documentation boilerplate template for projects that don't have or require complex documentation. It is designed to give users a clear, concise overview of the documentation provided.

Built with modern technologies:

• Next.js & React
  • SSG
  • dynamic imports
  • chakra-ui
• Typescript
• MDX
  • batteries-included styling
  • custom components
• SCSS

With this tech stack, each HandyDocs instance is easily configurable & customizable to suite your project.

🚀 Quickstart

Easy as 1, 2, 3!

1. Fork the chroline/handydocs template repo. This will give you a blank canvas for your HandyDocs instance. (Or, use degit to scaffold your project by running degit chroline/handydocs)

2. Clone your forked repo to your local machine.

   git clone *YOUR_REPO*

3. Customize your instance and add content.

...and then you're done!

Since HandyDocs is built with JAMStack technologies, you can deploy your instance to your favorite serverless/static web host provider like Vercel or Netlify.

📖 Documentation

Read the official docs at https://handydocs.colegaw.in/ to read the full documentation on how to configure your own HandyDocs instance.

🧑‍💻 Contributing

Interested in contributing to the HandyDocs project? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.

If you have a contribution in mind, please check out our Contribution Guide for information on how to do so. Also, make sure you read our Code of Conduct to foster an encouraging sense of community.

📄 License

HandyDocs is free and open-source software licensed under the MIT License. View the full license