https://github.com/sodiray/chiller

https://github.com/sodiray/chiller

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sodiray/chiller
• Owner: sodiray
• Created: 2022-12-23T05:40:49.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-27T20:07:38.000Z (about 2 years ago)
• Last Synced: 2025-03-27T10:37:27.822Z (7 months ago)
• Language: TypeScript
• Homepage: chiller-docs.vercel.app
• Size: 2.51 MB
• Stars: 39
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Chiller



  


    

  





  


    A cutting edge documentation site generator 

    


    


        

            Full Documentation

        

    

  



## How it works

1. Create a `chiller.json` config file

2. Install chiller `yarn add chiller`

3. Install the chiller app `chiller install`

4. Sync your documentation files `chiller sync`

5. Start the chiller app `chiller dev`

## Config

Here's a short example config chiller.json file you can use to start a chiller docs app. Learn about all the config options in [the docs](https://chiller-docs.vercel.app/config)

```json

{

  "name": "Chiller",

  "favicon": "favicon.ico",

  "domain": "https://chiller-docs.vercel.app",

  "description": "A cutting edge documentation site generator",

  "index": "/intro",

  "logo": "logo.png",

  "pages": "./*.mdx",

  "sidebar": {

    "links": [

      {

        "url": "/intro",

        "icon": "book",

        "label": "Documentation"

      }

    ]

  }

}

```

## The Repository

The repo has two projects: `cli` and `app`. The `cli` is the node cli used to execute commands like `chiller install -f` or `chiller build`. The app is the fork of tailwindcss.com's front end next.js app.

## Local Development

The `app` project is a _template_. It's a nextjs app that requires additional config and resource files before it can run. To run locally, we'll copy chiller's own documenation config and resource files into the `app` directory and then run it.

Follow these steps

- `cd` into the `cli` directory and run `yarn install-local` so you can use the `chiller` cli command

- `cd` back to the project root and run `chiller sync --dest ./app`. This will copy the `chiller.json` config, the `.mdx` documentation files and the `.png` images from the `./docs` directory into the `app` directory.

- `cd` into the `app` directory and run `yarn dev`