Skip to content

RoiTabach/handbook

 
 

Repository files navigation

Elementary Handbook

Welcome to the Elementary Handbook

🚀 Setup

Simply merge in this PR and your documentation will be connected!

👩‍💻 Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i mintlify -g

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Note - mintlify dev requires yarn and it's recommended you install it as a global installation. If you don't have yarn installed already run npm install --global yarn in your terminal.

😎 Publishing Changes

Changes will be deployed to production automatically after pushing to the default branch.

You can also preview changes using PRs, which generates a preview link of the docs.

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Mintlify dev is updating really slowly - Run mintlify clear to clear the cache.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published