-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |