From 88e8280e481d406166a3b0144a97849a1e63cde7 Mon Sep 17 00:00:00 2001 From: dphuang2 Date: Mon, 9 Oct 2023 19:21:34 -0700 Subject: [PATCH] Update README.md --- generator/konfig-docs/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/generator/konfig-docs/README.md b/generator/konfig-docs/README.md index aaba2fa1e..5dd22ac43 100644 --- a/generator/konfig-docs/README.md +++ b/generator/konfig-docs/README.md @@ -24,6 +24,18 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### How to make a new page + +1. Create an `.mdx` file inside [`docs/`](./docs) *(`.mdx` is just markdown with some extra support for interactivity)* +1. Modify [`sidebars.js`](./sidebars.js) to include your new documentation +1. Push changes + +### How to modify a page + +1. Modify the target `.mdx` file inside [`docs/`](./docs) *(`.mdx` is just markdown with some extra support for interactivity)* +1. Push changes + ### Deployment Using SSH: