Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.56 KB

Developer Portal

This project stores the files for the Espressif Developer Portal website. GitHub Actions statically generate the website using Hugo and pushes it to a web server for online hosting.

Contribute and render locally

If you want to contribute to this project, it would be nice to see the rendered version. The website can be easily rendered on your local machine using the following steps:

  1. Clone this repository using git clone --recursive.
  2. Install Hugo following the instructions.
  3. In the project folder, run hugo server and open the provided local web address, usually http://localhost:1313/.

See also the Contribution Guide articles:

Use pre-commit

This project has a pre-commit hook that can perform the following checks:

  • Enforce coding standards and best practices in the project's codebase
  • Check links using lychee
    • Important: requires Docker
    • lychee also runs as a GitHub action on pushes to main

If you want to use pre-commit, in your project folder, run:

# Install requirements
pip install -r requirements.txt
# Set up git hook scripts
pre-commit install
# Remove git hook scripts (if not needed)
pre-commit uninstall