A collection of clever yet understated user interactions found on the web. This project uses React to keep the example code simple and brief.
- Create a new markdown file in the
content
folder. For examplemy-cool-example.md
. - Add the following front matter attributes:
title: My Cool Example
date: 2019-09-24
author: John Doe
github: johndoe123
- Add your example code and relevant content using markdown syntax.
- Submit a pull request with the new markdown file.
- Once merged into
master
the website will automatically deploy to https://subtle-ui.netlify.com. 🎉
Important Note: This project uses a custom component to render markdown code blocks as live code including a preview. There are a few unique characteristics to be aware of:
- Code blocks are configured with React and Styled Components already in the scope.
- Code blocks should be written as imperative code and you need to call
render
with your JSX elements at the bottom. - You may use ES6 syntax if desired as code is transpiled via Babel.
- At this time there is no way to import other external libraries. If you have any questions or need additional functionality please file an issue.
yarn develop
- See a local version of the website on http://localhost:8000
yarn build && yarn serve
- See a production version of the website on http://localhost:9000