https://github.com/elementary-data/handbook
https://github.com/elementary-data/handbook
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elementary-data/handbook
- Owner: elementary-data
- Created: 2022-11-17T19:16:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-07-23T07:54:36.000Z (9 months ago)
- Last Synced: 2025-08-31T22:36:14.792Z (8 months ago)
- Language: MDX
- Size: 16.4 MB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Elementary Handbook
Welcome to the Elementary Handbook
### 🚀 Setup
Simply merge in this PR and your documentation will be connected!
### 👩💻 Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) 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.