Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

110 lines (74 loc) · 3.94 KB
Raw

Contribute to Hextra

👋 Thank you for being interested in contributing to Hextra! As an open source project, we welcome contributions of many forms including bug reports, feature requests, documentation improvements, and code contributions.

Table of Contents

Guidelines

Contributing Code

To contribute, please follow the "Fork and Pull Request" workflow：

Fork the repository, make your changes, and then submit a pull request. Please make sure to include a description of the changes you made and why you made them. Use Conventional Commits message to make it easier to understand the changes you made.

Contributing Documentation

Similar to contributing code, you can also contribute to the documentation by submitting a pull request.

The documentation site is located in the exampleSite folder. You can make changes to the documentation and create a pull request. A preview of the new documentation will be automatically generated and displayed in the pull request comment via Netlify.

💬 GitHub Discussions

We’re using Discussions as a place to connect with other members using Hextra:

  • Ask questions you’re wondering about.
  • Share ideas.
  • Engage with other users.

GitHub Issues

If you find a bug or have a feature request, please open an issue.

Please make sure to include a description of the bug or feature you are requesting. If you are reporting a bug, please include steps to reproduce the bug.

We recommend that you search existing issues or discussions before opening a new one to prevent duplicates.

Development

Note You can start developing on GitHub Codespaces or use devcontainer locally without installing any dependencies.

Local development setup

Install dependencies:

npm i

Project structure

  • assets: CSS styles and JavaScript files.
  • data: The theme data files. Now only contains the icons.yaml file.
  • exampleSite: The documentation site for the theme.
  • i18n: The theme translation files.
  • layouts: The theme layouts.
  • static: The static files for the theme. For example, the favicon and the site logo.

Please refer to the Hugo documentation for more information.

Start the development server

npm run dev:theme

It will start the Hugo server on http://localhost:1313/ for the exampleSite content.

Compile the styles

For development preview, we compile the Tailwind CSS styles on the fly. But for production, we need to compile the styles first.

npm run build:css

It will compile the Tailwind CSS styles and generate the assets/css/compiled/main.css file.