An open API service indexing awesome lists of open source software.

https://github.com/pskinnertech/mintlify-docs


https://github.com/pskinnertech/mintlify-docs

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# Alpha School Documentation

Documentation for [Alpha School](https://alpha.school/) - where kids crush academics in 2 hours, build life skills through workshops, and thrive beyond the classroom.

This documentation is built with Mintlify and covers Alpha School's innovative educational approach, programs, and resources.

## Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:

```
npm i -g mint
```

Run the following command at the root of your documentation, where your `docs.json` is located:

```
mint dev
```

View your local preview at `http://localhost:3000`.

## Publishing changes

Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

## Need help?

### Troubleshooting

- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.

### Resources
- [Mintlify documentation](https://mintlify.com/docs)
- [Mintlify community](https://mintlify.com/community)