vndre / redhooks-docs

documentation site for https://github.com/iusehooks/redhooks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

run locally

  1. Install dependencies
yarn
  1. Run a dev server on :8000
yarn dev

pages structure

all .mdx files inside docs folder are turned into urls:

  • readme.mdx -> '/' (root)
  • something.mdx -> '/something'

doc template

All docs must contain the following information:

---
title: <page title>
description: <desc>
position: <the order in the navigation>
---

code blocks must be followed by 'javascript':

```javascript

// code

\```

production

yarn build

creatres /dist

yarn prod (serves at localhost)
yarn prod:web (serves at 0.0.0.0)

About

documentation site for https://github.com/iusehooks/redhooks

License:MIT License


Languages

Language:JavaScript 100.0%