Giter VIP home page Giter VIP logo

frankenphp-website's Introduction

FrankenPHP Documentation

This repository contains the source code powering frankenphp.dev. The site is built using Hugo, a static site generator, and styled with Tailwind CSS.

Getting Started

To work on this project and update the Tailwind CSS locally, follow these steps:

1. Clone the Repository

First, clone this repository to your local machine and init the project:

git clone [email protected]:dunglas/frankenphp-website.git
cd frankenphp-website
pnpm install

2. Clone the Documentation

Before building the project, you need to fetch the documentation content. Run the following command to clone the documentation:

php clone-documentation.php

Please note that you might need to set up a GitHub token with the necessary permissions as a GITHUB_KEY environment variable.

3. Update Tailwind CSS Locally

To watch and update the Tailwind CSS during development, use the following command:

pnpm watch

4. Run the project locally

Once you have cloned the documentation and updated the CSS, you can start the development server using Hugo. Open a new terminal tab or window and run the following command:

hugo server --disableFastRender

This will launch a local server, and you can access the FrankenPHP Documentation site at http://localhost:1313.

Prettier Integration

Prettier is configured in this project to help you maintain consistent and well-formatted templates. To format your Hugo templates, use the following command:

pnpm prettify

frankenphp-website's People

Contributors

ginifizz avatar dunglas avatar anthemaker avatar cecileamrl avatar ottaviano avatar j3m5 avatar lewissteele avatar priyashpatil avatar paullallier avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.