https://github.com/useflyyer/flyyer-docs
Public collaborative documentation and guides for Flyyer.io
https://github.com/useflyyer/flyyer-docs
documentation docusaurus flyyer og-images react social-image typescript vue
Last synced: about 1 month ago
JSON representation
Public collaborative documentation and guides for Flyyer.io
- Host: GitHub
- URL: https://github.com/useflyyer/flyyer-docs
- Owner: useflyyer
- Created: 2020-12-26T17:56:57.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T23:30:58.000Z (almost 4 years ago)
- Last Synced: 2025-12-02T08:55:23.446Z (5 months ago)
- Topics: documentation, docusaurus, flyyer, og-images, react, social-image, typescript, vue
- Language: JavaScript
- Homepage: https://docs.flyyer.io
- Size: 3.67 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog/2020-12-26-free-new-look.md
Awesome Lists containing this project
README
# docs.flyyer.io
> CSS Theme: https://facebookincubator.github.io/infima/
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
### Using remote files
To avoid copy-paste going out of sync with different projects you can use this MDX component to render remote files:
```jsx
export const RemoteFile = ({children, source, ...props}) => {
const [code, setCode] = React.useState(null);
const [error, setError] = React.useState(null);
React.useEffect(() => {
fetch(source)
.then((res) => {
if (res.ok) {
res.text().then(text => setCode(text));
} else {
res.text().then(err => setError(new Error(err)));
}
})
.catch(err => setError(err));
}, [source]);
return (
{code || "Loading..."}
)
};
```
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Just push to `main`. We are using Vercel to deploy.