alexsandrohaag / appsmith-docs

Mirror of documentation at https://docs.appsmith.com. Raise Pull requests against this repository to update the documentation

Home Page:https://docs.appsmith.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Appsmith Documentation

This is the source of documentation for Appsmith, hosted at docs.appsmith.com, powered by Docusaurus v2.

Installation

Navigate to the website sub-directory

$ cd website

Run the below command to install node-modules

$ npm install package.json

Local Development

To set up the local development environment

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

It would help if you verified all your changes with a local build.

$ npm run build

This command generates static content into the build directory. You can use the local builds to verify your added content before raising a PR.

Test

$ npm run serve

This command is used to verify the content generated in the build directory. It acts as a simulator on your local machine to verify the actual build once the content is merged/deployed to the website.

About

Mirror of documentation at https://docs.appsmith.com. Raise Pull requests against this repository to update the documentation

https://docs.appsmith.com


Languages

Language:JavaScript 74.7%Language:CSS 14.2%Language:Shell 11.1%