Skip to content

Commit

Permalink
📖 Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rowanc1 committed Mar 11, 2024
1 parent 44d829b commit 84c6669
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# mystmd.org

This repository holds the theme for https://mystmd.org as well as the content for the landing/overview pages of the website.

The theme is a custom [Remix](https://remix.run) application that depends on [myst-theme](https://github.com/executablebooks/myst-theme) components. The web application brings together documentation from multiple different projects and provides a custom splash page, sandbox and search experience.

## Local Development

To see the theme locally:

```
cd theme
npm install
npm run start
```

This currently loads content off of the curvenote CDN for pages, which may be changed in the future.

0 comments on commit 84c6669

Please sign in to comment.