Skip to content

Commit

Permalink
add configuration details to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DarrenBaldwin07 committed Oct 4, 2023
1 parent 54cd4d0 commit b705720
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/landing/app/routes/docs.configuration.doc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,11 @@ bindings_export_path = "pages/api"
<br />

## Config options
> Coming soon...
<p>`port` - specifies the port address to run the rapid server on (defaults to 8080)</p>
<p className='mt-2'>`is_logging` - toggles logging to on/off</p>
<p className='mt-2'>`show_error_pages` - toggles the styles rapid error pages (true by default)</p>
<p className='mt-2'>`bindings_export_path` - the path to where Rapud should create the `bindings.ts` file for storing typescript types</p>
<p className='mt-2'>`serve_static_files` - enables static file serving from the /public directory</p>
<p className='mt-2'>`routes_directory` - the directory where all your route handlers live (always defaults to "src/routes")</p>
<p className='mt-2'>`typescript_generation` - enables typescript type generation</p>
<p className='mt-2'>`typescript_generation_directory` - the directory that you want to parse for typescript type generation</p>
7 changes: 7 additions & 0 deletions docs/landing/app/routes/docs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ export const getNextDocPathName = (currentPathName?: string) => {
path: '/docs/configuration',
text: 'Configuration',
};
case '/docs/configuration/doc':
return {
path: '/docs/vanilla',
text: 'Vanilla',
};
default:
return {
path: '/docs/quickstart',
Expand All @@ -59,6 +64,8 @@ export const shouldShowDocsNavigation = (pathname: string) => {
'/docs/middleware/doc',
'/docs/type-safety',
'/docs/type-safety/doc',
'/docs/configuration',
'/docs/configuration/doc',
];

return docsRoutes.includes(pathname);
Expand Down

0 comments on commit b705720

Please sign in to comment.