Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.32 KB
Raw

Contributing

The Capacitor website (capacitor-site/) and documentation (capacitor-site/pages/docs) live alongside the code. Looking to assist? See Capacitor issues labeled "docs" here.

Setup

  1. Fork this repo.
  2. Clone your fork.
  3. Make a branch for your change.
  4. Run npm install.
  5. Run npm start to build and deploy the website/docs to localhost.

Note: Content updated while the dev server is running won't be reflected locally. Stop the process, then re-run npm start.

Adding a new page to the sidebar

Docs

  • Navigate to capacitor-site/pages/docs/
  • For the Guide menu, add to capacitor-site/pages/docs/guide/README.md
  • For the Plugins menu, add to capacitor-site/pages/docs/plugins/README.md
  • For the CLI menu, add to capacitor-site/pages/docs/reference/README.md

Modifying documentation

For smaller edits, navigate to the desired page in the Capacitor docs then click the "Submit an edit" button.

  1. Locate the doc you want to modify in capacitor-site/pages/docs/.
  2. Modify the documentation, making sure to keep the format the same as the rest of the doc.
  3. Run npm run site-structure to rebuild the content.
  4. Run npm start to make sure your changes look correct.