https://github.com/useflyyer/flyyer-deck-docs

Templates for https://docs.flyyer.io
https://github.com/useflyyer/flyyer-deck-docs

example flyyer image-generator open-graph react socialpreview twitter-cards

Last synced: 8 days ago
JSON representation

Templates for https://docs.flyyer.io

• Host: GitHub
• URL: https://github.com/useflyyer/flyyer-deck-docs
• Owner: useflyyer
• Created: 2020-08-10T12:51:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T14:24:01.000Z (about 2 years ago)
• Last Synced: 2024-11-14T05:28:06.642Z (2 months ago)
• Topics: example, flyyer, image-generator, open-graph, react, socialpreview, twitter-cards
• Language: CSS
• Homepage: https://docs.flyyer.io
• Size: 1.88 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🌠 Flayyer template

Feel free to checkout the latest documentation at [app.flayyer.com/docs](http://app.flayyer.com/docs) 📖

## Development

You can start a development server at [http://localhost:7777](http://localhost:7777) with:

```sh

npm run start

# Custom port and host

npm run start --port 3000 --host 0.0.0.0

```

Then preview your template at [http://localhost:7777/page.html](http://localhost:7777/page.html)

## Deployment

Once you are ready to deploy please remember to build the project first:

```sh

npm run build

```

Get your Flayyer key from [https://app.flayyer.com](https://app.flayyer.com) and set it as an environment variable:

```sh

export FLAYYER_KEY=...

```

Deploy to production

```sh

npm run deploy

```

You can find the URL for your deck in the terminal output.

## Flayyer Studio

For a better development experience visit [flayyer.github.io/flayyer-studio/](https://flayyer.github.io/flayyer-studio/)

![flayyer studio screenshot](https://github.com/flayyer/flayyer-studio/raw/main/.github/screenshot.png)

## FAQ & Caveats

### SCSS Support

Sure. Install `npm install --save sass` and just import your SASS/SCSS files just like: `import "/styles.scss"`.

> See: https://app.flayyer.com/en/docs/structure/styles

### Custom fonts

Refer to https://app.flayyer.com/en/docs/structure/fonts.

### Nested directories

**This is not implemented yet. Please prefer a flat `/templates` directory.** This means you have to avoid folders inside `/templates`.

Folders outside `/templates` is ok 👍

### Development server crashes or stop previewing

The development server (`npm start`) can be buggy sometimes. Please restart the server if you encounter any problems.