From 1639fc02324f3c84fa91451bc95558b66778e67b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ars=C3=A8ne=20Fougerouse?= Date: Tue, 24 Oct 2023 11:32:46 +0200 Subject: [PATCH] docs: add readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Arsène Fougerouse --- README.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6574d97..0699164 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,34 @@ -# Nextra Docs Template +# FAAST DOC -This is a template for creating documentation with -[Nextra](https://nextra.site). +This folder contains the source code of the [Morty documentation website](#). -[**Live Demo →**](https://nextra-docs-template.vercel.app) +## Contributing -[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app) +You can [submit an issue](https://github.com/morty-faas/docs/issues/new/choose) +with documentation request or submit a pull request with suggested changes. -## Quick Start +To help you, all the documentation pages have a button **Edit this page** at the +right to go directly to the associated markdown file on the repository. -Click the button to clone this repository and deploy it on Vercel: +Please refer to the main [CONTRIBUTING.md](#) for contributing guidelines. -[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false) +## Development -## Local Development +Below a guide to help you run the website locally and preview changes before +submitting them. -First, run `pnpm i` to install the dependencies. +Please ensure that your environment match the following requirements : -Then, run `pnpm dev` to start the development server and visit localhost:3000. +- [pnpm](https://pnpm.io/installation) +- [NodeJS](https://nodejs.org/en/) (v17+) -## License +To run the website locally : -This project is licensed under the MIT License. +```bash +pnpm install +pnpm dev +``` + +The website should now be up and running at http://localhost:3000. Next.js will +automatically reload your changes. When you're done, stop the server by hitting +`CTRL+C`.