www.ory.sh

This is the www.ory.sh website!

Contributing

Contributions are welcome but must follow the contribution guidelines and code of conduct.

Considerations

TODO: write something clever about changing paths and redirects

Writing

TODO: write something clever about the process.

Blog Articles

When editing files of the Git repository, the blog post files must use the .mdx extension and placed in the src/markdown/blog folder.

TODO

• frontmatter fields
• using Netlify CMS
• taxonomy URLs

Pages

Pages are kept in src/pages and must be markdown files. Additionally, you need to add meta information at the top of the markdown file:

---
path: '/the-path'
title: 'The Page Title'
---

The text of your article...

• path: The page's URL (e.g. /about-us). Start with leading slash!
• title: Page title in the hero section.

Development

Use the npm start command will start a Gatsby development server, a Storybook server (on port 6006) and a Netlify CMS proxy server to work locally.
Alternatively, you can run npm run start:gatsby and npm run start:netlifycmsproxy (or npx nodemon -w static/admin/config.yml -x 'npx netlify-cms-proxy-server') in separate terminals.

You can then visit http://localhost:8000 in your browser (if you use the default port) and http://localhost:8000/admin to use the Netlify CMS.

CI

Pull requests will automatically be deployed to a Netlify preview URL (made availiable in the PR discussion).

If you wish to build the Storybook, you can do so by adding with-storybook in the name of your branch.

The Storybook will then be available at /storybook.

TBC: Should we check the commit message instead? Is it possible?

Icons

phosphoricons.com