Overview
The packit.dev repository is a collection of documentation and GitHub Actions used for the deployment of the packit.dev website. This repository provides instructions for installation, local development, containerization, and features such as blog post previews and author specifications.
Features
- Installation: The repository includes a makefile target that imports deployment and research docs, installs yarn and JS dependencies for the webpage.
- Local Development: The repository provides a command to start a local development server and open a browser window, allowing for live reflection of most changes without server restart.
- Containerization: Instructions are provided for running the repository from a container, including the installation of JS dependencies and building the webpage.
- Content: Majority of the content is organized into directories such as development documentation, documentation, blog posts, source-git documentation, and weekly updates.
- Docusaurus features: The repository leverages Docusaurus features, including admonitions for note, tip, info, caution, and danger messages.
- Blog post previews: Each blog post has a preview section that can be customized with a “mouth-watering” paragraph followed by a
<!--truncate-->mark to specify the end of the preview. - Blog post authors: Blog posts can be authored by individuals listed in the
authors.ymlfile, specifying name, email, title, URL, and photo. - Images: Images are stored close to the content in an
imgdirectory, allowing for shorter links and better organization.
Installation
For the initial installation, the following steps can be performed:
- Use the makefile target to import deployment and research docs and install yarn and JS dependencies for the webpage.
For local development, the following steps can be performed:
- Use the command
yarn startormake run-devto start a local development server and open a browser window.
Summary
The packit.dev repository is a comprehensive collection of documentation, GitHub Actions, and resources for deploying the packit.dev website. It provides installation instructions, guidance for local development, and containerization. The repository also highlights features such as blog post previews, author specifications, and image organization.