https://github.com/espressif/developer-portal

Developer Portal
https://github.com/espressif/developer-portal

Last synced: 2 days ago
JSON representation

Developer Portal

• Host: GitHub
• URL: https://github.com/espressif/developer-portal
• Owner: espressif
• License: mit
• Created: 2024-02-08T09:26:09.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-17T04:23:28.000Z (4 months ago)
• Last Synced: 2024-05-17T05:30:42.948Z (4 months ago)
• Language: CSS
• Homepage: https://developer.espressif.com
• Size: 15.7 MB
• Stars: 2
• Watchers: 9
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

[Espressif Developer Portal]: https://developer.espressif.com/

## 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](https://gohugo.io/installation/).

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:

- [Contribution workflow](./content/pages/contribution-guide/contrib-workflow/index.md)

- [Writing content](./content/pages/contribution-guide/writing-content/index.md)

## 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

[pre-commit]: https://pre-commit.com/

[lychee]: https://github.com/lycheeverse/lychee

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

```sh

# 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

```