diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..02b176d69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +## Bug description + + +## Steps to reproduce + + +## Expected behavior + + +## Screenshots + + +## Environment + diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md new file mode 100644 index 000000000..7a2df3f90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.md @@ -0,0 +1,8 @@ +--- +name: Discussion +about: Discuss something with us + +--- + +## Description + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..59b6f461d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,9 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +## Description + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..12c0c2862 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ + + +## Description + + + + +## PR Type +- [ ] Snippets, Tests & Tags (new snippets, updated snippets, re-tagging of snippets, added/updated tests) +- [ ] Tools, Scripts & Automation (anything related to files in the scripts folder, Gatsby, website, Travis CI or Netlify) +- [ ] General, Typos, Misc. & Meta (everything related to content, typos, general stuff and meta files in the repository - e.g. the issue template) +- [ ] Other (please specifiy in the description above) + +## Guidelines +- [ ] I have read the guidelines in the [CONTRIBUTING](https://github.com/30-seconds/30-seconds-of-react/blob/master/CONTRIBUTING.md) document. diff --git a/.gitignore b/.gitignore index c221276eb..29d9977a5 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,7 @@ coverage # nyc test coverage .nyc_output -# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt # Bower dependency directory (https://bower.io/) @@ -51,23 +51,23 @@ typings/ # Output of 'npm pack' *.tgz +# Yarn +yarn-error.log +.pnp/ +.pnp.js + # Yarn Integrity file .yarn-integrity # dotenv environment variables file .env -# parcel-bundler cache (https://parceljs.org/) -.cache - # next.js build output .next -# nuxt.js build output -.nuxt +# gatsby files +.cache/ +public -# vuepress build output -.vuepress/dist - -# Serverless directories -.serverless +# Mac files +.DS_Store \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..ad4d6e410 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +language: node_js +cache: + directories: + - node_modules +node_js: +- lts/* +script: +- npm run extractor +- npm run builder +after_success: +- chmod +x .travis/push.sh +- .travis/push.sh \ No newline at end of file diff --git a/.travis/push.sh b/.travis/push.sh new file mode 100644 index 000000000..f60647fd8 --- /dev/null +++ b/.travis/push.sh @@ -0,0 +1,35 @@ +#!/bin/bash +setup_git() { + git config --global user.email "30secondsofcode@gmail.com" + git config --global user.name "30secondsofcode" +} + +commit_website_files() { + if [ $TRAVIS_EVENT_TYPE != "pull_request" ]; then + if [ $TRAVIS_BRANCH == "master" ]; then + echo "Committing to master branch..." + git checkout master + git add * + if [ $TRAVIS_EVENT_TYPE == "cron" ]; then + git commit --message "Travis build: $TRAVIS_BUILD_NUMBER [cron]" + elif [ $TRAVIS_EVENT_TYPE == "api" ]; then + git commit --message "Travis build: $TRAVIS_BUILD_NUMBER [custom]" + else + git commit --message "Travis build: $TRAVIS_BUILD_NUMBER" + fi + fi + fi +} + +upload_files() { + if [ $TRAVIS_EVENT_TYPE != "pull_request" ]; then + if [ $TRAVIS_BRANCH == "master" ]; then + echo "Pushing to master branch..." + git push --force --quiet "https://${GH_TOKEN}@github.com/30-seconds/30-seconds-of-react.git" master > /dev/null 2>&1 + fi + fi +} + +setup_git +commit_website_files +upload_files diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..53001a0b0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at 30secondsofcode@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4f398398..ffae9dd84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,12 +11,18 @@ Here's what you can do to help: ### Snippet submission and Pull request guidelines -- **DO NOT MODIFY THE README.md or index.html FILES!** Make changes to individual snippet files. **Travis CI** will automatically build the `README.md` and `index.html` files when your pull request is merged. +- **DO NOT MODIFY THE README.md FILE!** Make changes to individual snippet files. **Travis CI** will automatically build the `README.md` file when your pull request is merged. - **Snippet filenames** must correspond to the title of the snippet. For example, if your snippet is titled `### AwesomeComponent` the filename should be `AwesomeComponent.md`. - Use `TitleCase`, not `camelCase`, `kebab-case` or `snake_case` when naming components. + - Use `camelCase`, not `TitleCase`, `kebab-case` or `snake_case` when naming custom hooks. - Avoid capitalization of words, except if the whole word is capitalized (e.g. `URL` should be capitalized in the filename and the snippet title). -- **Snippet titles** should be the same as the name of the component that is present in the snippet. - - All snippet titles must be prefixed with `###` and be at the very first line of your snippet. +- **Snippet metadata** must be included in all snippets in the form of frontmatter. + - All snippets must contain a title. + - All snippets must contain tags, prefixed with `tags:` and separated by commas (optional spaces in-between). + - Make sure the first tag in your snippet's tags is one of the main categories, as seen in the `README.md` file or the website. + - Snippet tags must include a difficulty setting (`begginer`, `intermediate` or `advanced`), preferrably at the end of the list. +- **Snippet titles** should be the same as the name of the component or hook that is present in the snippet. + - All snippet titles must be prefixed with `title:` and be at the very first line of your snippet's frontmatter. - Snippet titles must be unique (although if you cannot find a better title, just add some placeholder at the end of the filename and title and we will figure it out). - Follow snippet titles with an empty line. - **Snippet descriptions** must be short and to the point. Try to explain _what_ the snippet does and _how_ the snippet works and what Javascript/React features are used. Remember to include what functions you are using and why. diff --git a/_headers b/_headers new file mode 100644 index 000000000..4c2f41f08 --- /dev/null +++ b/_headers @@ -0,0 +1,4 @@ +[[headers]] +for = "/static/*" +[headers.values] +Cache-Control = "public, max-age=360000" \ No newline at end of file diff --git a/gatsby-browser.js b/gatsby-browser.js new file mode 100644 index 000000000..09c615eb2 --- /dev/null +++ b/gatsby-browser.js @@ -0,0 +1,8 @@ +/** + * Implement Gatsby's Browser APIs in this file. + * + * See: https://www.gatsbyjs.org/docs/browser-apis/ + */ + +// You can delete this file if you're not using it +export { default as wrapRootElement } from './src/docs/state/ReduxWrapper'; diff --git a/gatsby-config.js b/gatsby-config.js new file mode 100644 index 000000000..448c152b1 --- /dev/null +++ b/gatsby-config.js @@ -0,0 +1,82 @@ +const config = require('./config'); + +module.exports = { + siteMetadata: { + title: `${config.name}`, + description: `${config.description}`, + author: `@30-seconds`, + }, + plugins: [ + `gatsby-plugin-transition-link`, + { + resolve: `gatsby-source-filesystem`, + options: { + name: `snippets`, + path: `${__dirname}/${config.snippetPath}`, + }, + }, + { + resolve: `gatsby-source-filesystem`, + options: { + name: `snippet_data`, + path: `${__dirname}/${config.snippetDataPath}`, + }, + }, + { + resolve: `gatsby-source-filesystem`, + options: { + name: `assets`, + path: `${__dirname}/${config.assetPath}`, + }, + }, + { + resolve: `gatsby-plugin-page-creator`, + options: { + path: `${__dirname}/${config.pagePath}`, + }, + }, + { + resolve: `gatsby-transformer-remark`, + options: { + plugins: [ + { + resolve: `gatsby-remark-images`, + options: { + maxWidth: 590, + }, + }, + `gatsby-remark-prismjs`, + `gatsby-remark-copy-linked-files`, + ], + }, + }, + `gatsby-plugin-sass`, + `gatsby-transformer-json`, + `gatsby-transformer-sharp`, + `gatsby-plugin-sharp`, + { + resolve: `gatsby-plugin-google-analytics`, + options: { + trackingId: `UA-117141635-1`, + anonymize: true, // Always set this to true, try to comply with GDPR out of the box + respectDNT: true, // Always set to true, be respectful of people who ask not to be tracked + cookieExpires: 0, // Always set to 0, minimum tracking for your users + }, + }, + { + resolve: `gatsby-plugin-manifest`, + options: { + name: `${config.name}`, + short_name: `${config.shortName}`, + start_url: `/`, + background_color: `#1e253d`, + theme_color: `#1e253d`, + display: `standalone`, + icon: `assets/30s-icon.png`, // This path is relative to the root of the site. + }, + }, + `gatsby-plugin-offline`, + `gatsby-plugin-react-helmet`, + `gatsby-plugin-netlify`, + ], +}; diff --git a/gatsby-node.js b/gatsby-node.js new file mode 100644 index 000000000..9221ea486 --- /dev/null +++ b/gatsby-node.js @@ -0,0 +1,93 @@ +const path = require(`path`); +const { createFilePath } = require(`gatsby-source-filesystem`); + +const toKebabCase = str => + str && + str + .match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g) + .map(x => x.toLowerCase()) + .join('-'); + +exports.createPages = ({ graphql, actions }) => { + const { createPage } = actions; + + const snippetPage = path.resolve(`./src/docs/templates/SnippetPage.js`); + const tagPage = path.resolve(`./src/docs/templates/TagPage.js`); + return graphql( + ` + { + allMarkdownRemark( + sort: { fields: [frontmatter___title], order: ASC } + limit: 1000 + ) { + edges { + node { + fields { + slug + } + frontmatter { + tags + } + fileAbsolutePath + } + } + } + } + `, + ).then(result => { + if (result.errors) { + throw result.errors; + } + + // Create individual snippet pages. + const snippets = result.data.allMarkdownRemark.edges; + + snippets.forEach((post, index) => { + if (post.node.fileAbsolutePath.indexOf('README') !== -1) + return; + createPage({ + path: `/snippet${post.node.fields.slug}`, + component: snippetPage, + context: { + slug: post.node.fields.slug, + }, + }); + }); + + // Create tag pages. + const tags = snippets.reduce((acc, post) => { + if (!post.node.frontmatter || !post.node.frontmatter.tags) return acc; + const primaryTag = post.node.frontmatter.tags.split(',')[0]; + if (!acc.includes(primaryTag)) acc.push(primaryTag); + return acc; + }, []); + + tags.forEach(tag => { + const tagPath = `/tag/${toKebabCase(tag)}/`; + const tagRegex = `/^\\s*${tag}/`; + createPage({ + path: tagPath, + component: tagPage, + context: { + tag, + tagRegex, + }, + }); + }); + + return null; + }); +}; + +exports.onCreateNode = ({ node, actions, getNode }) => { + const { createNodeField } = actions; + + if (node.internal.type === `MarkdownRemark`) { + const value = createFilePath({ node, getNode }); + createNodeField({ + name: `slug`, + node, + value, + }); + } +}; diff --git a/gatsby-ssr.js b/gatsby-ssr.js new file mode 100644 index 000000000..3513ab31a --- /dev/null +++ b/gatsby-ssr.js @@ -0,0 +1,8 @@ +/** + * Implement Gatsby's SSR (Server Side Rendering) APIs in this file. + * + * See: https://www.gatsbyjs.org/docs/ssr-apis/ + */ + +// You can delete this file if you're not using it +export { default as wrapRootElement } from './src/docs/state/ReduxWrapper'; diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 000000000..3bcf87c32 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,6 @@ +[build] + publish = "public" + command = "npm run webber" +[build.environment] + YARN_VERSION = "1.9.4" + YARN_FLAGS = "--no-ignore-optional" \ No newline at end of file diff --git a/snippet-template.md b/snippet-template.md index 9492b357a..853ee24d8 100644 --- a/snippet-template.md +++ b/snippet-template.md @@ -1,3 +1,8 @@ +--- +title: ComponentName +tags: visual,state,effect,intermediate +--- + ### ComponentName Explain briefly what the snippet does. @@ -19,21 +24,3 @@ function ComponentName(props) { ```jsx ReactDOM.render(, document.getElementById('root')); ``` - - - -#### Notes: - -- Things to remember when using this -- Other options that might be less appealing or have lower compatibility -- Common mistakes and issues - - - - - diff --git a/src/docs/components/Meta.js b/src/docs/components/Meta.js new file mode 100644 index 000000000..c79e07669 --- /dev/null +++ b/src/docs/components/Meta.js @@ -0,0 +1,78 @@ +import React from 'react'; +import Helmet from 'react-helmet'; +import { useStaticQuery, graphql } from 'gatsby'; +require('../styles/index.scss'); // Do not change this to `import`, it's not going to work, no clue why + +// =================================================== +// Page metadata (using Helmet) +// =================================================== +const Meta = ({ description = '', lang = 'en', meta = [], title }) => { + const { site, file } = useStaticQuery( + graphql` + query { + site { + siteMetadata { + title + description + author + } + } + file(relativePath: { eq: "logo.png" }) { + id + childImageSharp { + fluid(maxHeight: 400) { + src + } + } + } + } + `, + ); + + const metaDescription = description || site.siteMetadata.description; + + return ( + + ); +}; + +export default Meta; diff --git a/src/docs/components/SVGs/BackArrowIcon.js b/src/docs/components/SVGs/BackArrowIcon.js new file mode 100644 index 000000000..789edf859 --- /dev/null +++ b/src/docs/components/SVGs/BackArrowIcon.js @@ -0,0 +1,22 @@ +import React from 'react'; + +const BackArrowIcon = ({ className, onClick }) => ( + + + + +); + +export default BackArrowIcon; diff --git a/src/docs/components/SVGs/ClipboardIcon.js b/src/docs/components/SVGs/ClipboardIcon.js new file mode 100644 index 000000000..e57f84b37 --- /dev/null +++ b/src/docs/components/SVGs/ClipboardIcon.js @@ -0,0 +1,22 @@ +import React from 'react'; + +const ClipboardIcon = ({ className, onClick }) => ( + + + + +); + +export default ClipboardIcon; diff --git a/src/docs/components/SVGs/CollapseClosedIcon.js b/src/docs/components/SVGs/CollapseClosedIcon.js new file mode 100644 index 000000000..a72270988 --- /dev/null +++ b/src/docs/components/SVGs/CollapseClosedIcon.js @@ -0,0 +1,23 @@ +import React from 'react'; + +const CollapseClosedIcon = ({ className, onClick }) => ( + + + + + +); + +export default CollapseClosedIcon; diff --git a/src/docs/components/SVGs/CollapseOpenIcon.js b/src/docs/components/SVGs/CollapseOpenIcon.js new file mode 100644 index 000000000..bcd04cb22 --- /dev/null +++ b/src/docs/components/SVGs/CollapseOpenIcon.js @@ -0,0 +1,22 @@ +import React from 'react'; + +const CollapseOpenIcon = ({ className, onClick }) => ( + + + + +); + +export default CollapseOpenIcon; diff --git a/src/docs/components/SVGs/DarkModeIcon.js b/src/docs/components/SVGs/DarkModeIcon.js new file mode 100644 index 000000000..318423094 --- /dev/null +++ b/src/docs/components/SVGs/DarkModeIcon.js @@ -0,0 +1,21 @@ +import React from 'react'; + +const DarkModeIcon = ({ className, onClick }) => ( + + + +); + +export default DarkModeIcon; diff --git a/src/docs/components/SVGs/GithubIcon.js b/src/docs/components/SVGs/GithubIcon.js new file mode 100644 index 000000000..5d2b2bb25 --- /dev/null +++ b/src/docs/components/SVGs/GithubIcon.js @@ -0,0 +1,21 @@ +import React from 'react'; + +const GithubIcon = ({ className, onClick }) => ( + + + +); + +export default GithubIcon; diff --git a/src/docs/components/SVGs/LightModeIcon.js b/src/docs/components/SVGs/LightModeIcon.js new file mode 100644 index 000000000..bb13cb19e --- /dev/null +++ b/src/docs/components/SVGs/LightModeIcon.js @@ -0,0 +1,29 @@ +import React from 'react'; + +const LightModeIcon = ({ className, onClick }) => ( + + + + + + + + + + + +); + +export default LightModeIcon; diff --git a/src/docs/components/SVGs/ListIcon.js b/src/docs/components/SVGs/ListIcon.js new file mode 100644 index 000000000..853b1a7b2 --- /dev/null +++ b/src/docs/components/SVGs/ListIcon.js @@ -0,0 +1,26 @@ +import React from 'react'; + +const ListIcon = ({ className, onClick }) => ( + + + + + + + + +); + +export default ListIcon; diff --git a/src/docs/components/SVGs/SearchIcon.js b/src/docs/components/SVGs/SearchIcon.js new file mode 100644 index 000000000..763ae3ea9 --- /dev/null +++ b/src/docs/components/SVGs/SearchIcon.js @@ -0,0 +1,24 @@ +import React from 'react'; + +const SearchIcon = ({ className, onClick }) => { + return ( + + + + + ); +}; + +export default SearchIcon; diff --git a/src/docs/components/SVGs/ShareIcon.js b/src/docs/components/SVGs/ShareIcon.js new file mode 100644 index 000000000..8e78b671e --- /dev/null +++ b/src/docs/components/SVGs/ShareIcon.js @@ -0,0 +1,25 @@ +import React from 'react'; + +const ShareIcon = ({ className, onClick }) => ( + + + + + + + +); + +export default ShareIcon; diff --git a/src/docs/components/Search.js b/src/docs/components/Search.js new file mode 100644 index 000000000..5b2903d43 --- /dev/null +++ b/src/docs/components/Search.js @@ -0,0 +1,28 @@ +import React from 'react'; + +// =================================================== +// Simple, stateful search component +// =================================================== +const Search = ({ defaultValue = '', setSearchQuery, className = '' }) => { + const [value, setValue] = React.useState(defaultValue); + + React.useEffect(() => { + setSearchQuery(value); + }, [value]); + + return ( + { + setValue(e.target.value); + }} + /> + ); +}; + +export default Search; diff --git a/src/docs/components/Shell.js b/src/docs/components/Shell.js new file mode 100644 index 000000000..988edf6e1 --- /dev/null +++ b/src/docs/components/Shell.js @@ -0,0 +1,149 @@ +import React from 'react'; +import { graphql, useStaticQuery } from 'gatsby'; +import { connect } from 'react-redux'; +import AniLink from 'gatsby-plugin-transition-link/AniLink'; +import ReactCSSTransitionReplace from 'react-css-transition-replace'; +import config from '../../../config'; + +import { toggleDarkMode } from '../state/app'; + +import SearchIcon from './SVGs/SearchIcon'; +import GithubIcon from './SVGs/GithubIcon'; +import DarkModeIcon from './SVGs/DarkModeIcon'; +import LightModeIcon from './SVGs/LightModeIcon'; +import ListIcon from './SVGs/ListIcon'; + +// =================================================== +// Application-level UI component +// =================================================== +const Shell = ({ + isDarkMode, + isSearch, + isList, + dispatch, + withIcon = true, + withTitle = true, + children, +}) => { + const data = useStaticQuery(graphql` + query SiteTitleQuery { + site { + siteMetadata { + title + description + } + } + file(relativePath: { eq: "30s-icon.png" }) { + id + childImageSharp { + original { + src + } + } + } + snippetDataJson(meta: { type: { eq: "snippetListingArray" } }) { + data { + title + id + attributes { + tags + } + } + } + } + `); + let viewportWidth = typeof window !== 'undefined' && window.innerWidth; + + return ( +
+ {/* Menu */} +
+ + + + + + + {/* eslint-disable-next-line */} + + + + {/* + The use of React.Fragment here will cause a lot of errors to show up in webber:dev. + Truth is, this is the only decent way I found to deal with this module's odd behavior. + Keep as is, unless you can provide a better solution, in which case please send a PR. + */} + + {isDarkMode ? ( + dispatch(toggleDarkMode(!isDarkMode))} + /> + ) : ( + dispatch(toggleDarkMode(!isDarkMode))} + /> + )} + +
+ {/* Content */} +
+ {withTitle ? ( +

+ {data.site.siteMetadata.title} + {withIcon ? ( + Logo + ) : ( + '' + )} +

+ ) : ( + '' + )} + {children} +
+
+ ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(Shell); diff --git a/src/docs/components/SimpleCard.js b/src/docs/components/SimpleCard.js new file mode 100644 index 000000000..cd93b6af9 --- /dev/null +++ b/src/docs/components/SimpleCard.js @@ -0,0 +1,21 @@ +import React from 'react'; + +// =================================================== +// Generic card (displays textual content) +// =================================================== +const SimpleCard = ({ + title, + children, + isDarkMode +}) => ( +
+

+ {title} +

+
+ {children} +
+
+); + +export default SimpleCard; diff --git a/src/docs/components/SnippetCard.js b/src/docs/components/SnippetCard.js new file mode 100644 index 000000000..cb83ee1aa --- /dev/null +++ b/src/docs/components/SnippetCard.js @@ -0,0 +1,186 @@ +import React from 'react'; +import { CopyToClipboard } from 'react-copy-to-clipboard'; +import config from '../../../config'; + +import { getTextualContent, getCodeBlocks, optimizeAllNodes } from '../util'; +// import ShareIcon from './SVGs/ShareIcon'; +import AniLink from 'gatsby-plugin-transition-link/AniLink'; +import CollapseOpenIcon from './SVGs/CollapseOpenIcon'; +import CollapseClosedIcon from './SVGs/CollapseClosedIcon'; +import ReactCSSTransitionReplace from 'react-css-transition-replace'; + +// =================================================== +// Snippet Card HOC - check components below for more +// =================================================== +const SnippetCard = ({ short, snippetData, ...rest }) => { + let difficulty = snippetData.tags.includes('advanced') + ? 'advanced' + : snippetData.tags.includes('beginner') + ? 'beginner' + : 'intermediate'; + return short ? ( + + ) : ( + + ); +}; + +// =================================================== +// Simple card corner for difficulty display +// =================================================== +const CardCorner = ({ difficulty = 'intermediate' }) => ( +
+); + +// =================================================== +// Full snippet view (tags, code, title, description) +// =================================================== +const FullCard = ({ snippetData, difficulty, isDarkMode }) => { + const [examplesOpen, setExamplesOpen] = React.useState(false); + const tags = snippetData.tags; + let cardCodeHtml = `${optimizeAllNodes( + getCodeBlocks(snippetData.html).code, + )}`; + let cardStyleHtml = `${optimizeAllNodes( + getCodeBlocks(snippetData.html).style, + )}`; + let cardExamplesHtml = `${optimizeAllNodes( + getCodeBlocks(snippetData.html).example, + )}`; + return ( +
+ +

{snippetData.title}

+ {tags.map(tag => ( + {tag} + ))} +
+
+ { + let tst = document.createElement('div'); + tst.classList = 'toast'; + tst.innerHTML = 'Snippet copied to clipboard!'; + document.body.appendChild(tst); + setTimeout(function() { + tst.style.opacity = 0; + setTimeout(function() { + document.body.removeChild(tst); + }, 300); + }, 1700); + }} + > + */} + { + cardStyleHtml &&
+        }
+        
+        
+        
+          {examplesOpen && (
+            
+          )}
+        
+      
+
+ ); +}; + +// =================================================== +// Short snippet view (title, description, code*) +// =================================================== +const ShortCard = ({ + snippetData, + withCode = false, + difficulty, + isDarkMode +}) => { + let cardCodeHtml; + if (withCode) + cardCodeHtml = `${optimizeAllNodes( + getCodeBlocks(snippetData.html).code, + )}`; + return ( +
+ +

+ + {snippetData.title} + +

+
+ {withCode ?
+ { + let tst = document.createElement('div'); + tst.classList = 'toast'; + tst.innerHTML = 'Snippet copied to clipboard!'; + document.body.appendChild(tst); + setTimeout(function() { + tst.style.opacity = 0; + setTimeout(function() { + document.body.removeChild(tst); + }, 300); + }, 1700); + }} + > +
: '' } +
+ ); +}; + +export default SnippetCard; diff --git a/src/docs/pages/404.js b/src/docs/pages/404.js new file mode 100644 index 000000000..5239aa371 --- /dev/null +++ b/src/docs/pages/404.js @@ -0,0 +1,60 @@ +import React from 'react'; +import { connect } from 'react-redux'; +import AniLink from 'gatsby-plugin-transition-link/AniLink'; + +import Shell from '../components/Shell'; +import Meta from '../components/Meta'; + +// =================================================== +// Not found page +// =================================================== +const NotFoundPage = ({ isDarkMode }) => ( + <> + + +

404

+
+

+ Page not found +
+

+

+ Seems like you have reached a page that does not exist. +

+ + + + + +   Go home + +
+
+ +); + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(NotFoundPage); diff --git a/src/docs/pages/about.js b/src/docs/pages/about.js new file mode 100644 index 000000000..e7fed6886 --- /dev/null +++ b/src/docs/pages/about.js @@ -0,0 +1,99 @@ +import React from 'react'; +import { connect } from 'react-redux'; + +import Shell from '../components/Shell'; +import Meta from '../components/Meta'; +import SimpleCard from '../components/SimpleCard'; + +// =================================================== +// About page +// =================================================== +const AboutPage = ({ isDarkMode }) => ( + <> + + +

About

+

+ A few word about us, our goals and our projects. +

+ +

+ The core goal of 30 seconds is to provide a quality resource for beginner and advanced developers alike. We want to help improve the software development ecosystem, by lowering the barrier of entry for newcomers and help seasoned veterans pick up new tricks and remember old ones. +

+

+ In order to achieve this, we have collected hundreds of snippets that can be of use in a wide range of situations. We welcome new contributors and we like fresh ideas, as long as the code is short and easy to grasp in about 30 seconds. +

+

+ The only catch, if you may, is that a few of our snippets are not perfectly optimized for large, enterprise applications and they might not be deemed production-ready. +

+
+ +

+ The 30 seconds movement started back in December, 2017, with the release of 30 seconds of code by Angelos Chalaris. Since then, hundreds of developers have contributed snippets to over 6 repositories, creating a thriving community of people willing to help each other write better code. +

+

+ In late 2018, the 30 seconds organization was formed on GitHub, in order to expand upon existing projects and ensure that they will remain high-quality resources in the future. +

+
+ +

+ The 30 seconds movement and, to some extent, the associated GitHub organization consists of all the people who have invested time and ideas to be part of this amazing community. Meanwhile, these fine folks are currently responsible for maintaining the codebases and dealing with organizational matters: +

+
+ +
+ fejes713 + Stefan Fejes +
+
+ flxwu + Felix Wu +
+
+ atomiks + atomiks +
+
+
+ + + +
+ sohelamin + Sohel Amin +
+
+
+ +

+ In order for the code provided via the 30 seconds projects to be as accessible and useful as possible, all of the snippets in these collections are licensed under the CC0-1.0 License meaning they are absolutely free to use in any project you like. If you like what we do, you can always credit us, but that is not mandatory. +

+

+ Logos, names and trademarks are not to be used without the explicit consent of the maintainers or owners of the 30 seconds GitHub organization. The only exception to this is the usage of the 30-seconds-of- name in open source projects, licensed under the CC0-1.0 License and hosted on GitHub, if their README and website clearly states that they are unofficial projects and in no way affiliated with the organization. +

+
+
+ +); + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(AboutPage); diff --git a/src/docs/pages/index.js b/src/docs/pages/index.js new file mode 100644 index 000000000..5be6815f7 --- /dev/null +++ b/src/docs/pages/index.js @@ -0,0 +1,157 @@ +import React from 'react'; +import { graphql } from 'gatsby'; +import { connect } from 'react-redux'; +import { pushNewPage, pushNewQuery } from '../state/app'; + +import Shell from '../components/Shell'; +import Meta from '../components/Meta'; +import Search from '../components/Search'; +import SnippetCard from '../components/SnippetCard'; + +import { getRawCodeBlocks as getCodeBlocks } from '../util'; + +// =================================================== +// Home page (splash and search) +// =================================================== +const IndexPage = props => { + const snippets = props.data.snippetDataJson.data.map(snippet => ({ + title: snippet.title, + html: props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.html, + tags: snippet.attributes.tags, + text: snippet.attributes.text, + id: snippet.id, + code: getCodeBlocks( + props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.rawMarkdownBody, + ).code, + })); + + const [searchQuery, setSearchQuery] = React.useState(props.searchQuery); + const [searchResults, setSearchResults] = React.useState(snippets); + + React.useEffect(() => { + props.dispatch(pushNewQuery(searchQuery)); + let q = searchQuery.toLowerCase(); + let results = snippets; + if (q.trim().length) + results = snippets.filter( + v => + v.tags.filter(t => t.indexOf(q) !== -1).length || + v.title.toLowerCase().indexOf(q) !== -1, + ); + setSearchResults(results); + }, [searchQuery]); + + React.useEffect(() => { + props.dispatch(pushNewPage('Search', '/search')); + }, []); + + return ( + <> + + + Logo +

{props.data.site.siteMetadata.title}

+

+ {props.data.site.siteMetadata.description} +

+ + {searchQuery.length === 0 ? ( +

+ Start typing a keyword to see matching snippets. +

+ ) : searchResults.length === 0 ? ( +

+ We couldn't find any results for the keyword{' '} + {searchQuery}. +

+ ) : ( + <> +

+ Click on a snippet's name to view its code. +

+

Search results

+ {searchResults.map(snippet => ( + + ))} + + )} +
+ + ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(IndexPage); + +export const indexPageQuery = graphql` + query snippetList { + site { + siteMetadata { + title + description + author + } + } + file(relativePath: { eq: "30s-icon.png" }) { + id + childImageSharp { + original { + src + } + } + } + snippetDataJson(meta: { type: { eq: "snippetListingArray" } }) { + data { + id + title + attributes { + tags + text + } + } + } + allMarkdownRemark( + limit: 1000 + sort: { fields: [frontmatter___title], order: ASC } + ) { + totalCount + edges { + node { + id + html + rawMarkdownBody + fields { + slug + } + frontmatter { + title + tags + } + } + } + } + } +`; diff --git a/src/docs/pages/list.js b/src/docs/pages/list.js new file mode 100644 index 000000000..e3e52d798 --- /dev/null +++ b/src/docs/pages/list.js @@ -0,0 +1,148 @@ +import React from 'react'; +import { graphql } from 'gatsby'; +import { connect } from 'react-redux'; +import { pushNewPage } from '../state/app'; +import { capitalize } from '../util'; + +import Shell from '../components/Shell'; +import Meta from '../components/Meta'; +import AniLink from 'gatsby-plugin-transition-link/AniLink'; +import SnippetCard from '../components/SnippetCard'; + +import { getRawCodeBlocks as getCodeBlocks } from '../util'; +import SimpleCard from '../components/SimpleCard'; + +// =================================================== +// Snippet list page +// =================================================== +const ListPage = props => { + const snippets = props.data.snippetDataJson.data.map(snippet => ({ + title: snippet.title, + html: props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.html, + tags: snippet.attributes.tags, + text: snippet.attributes.text, + id: snippet.id, + code: getCodeBlocks( + props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.rawMarkdownBody, + ).code, + })); + const tags = snippets.reduce((acc, snippet) => { + if (!snippet.tags) return acc; + const primaryTag = snippet.tags[0]; + if (!acc.includes(primaryTag)) acc.push(primaryTag); + return acc; + }, []); + const staticPages = [ + { + url: 'about', + title: 'About', + description: 'A few word about us, our goals and our projects.' + } + ]; + + React.useEffect(() => { + props.dispatch(pushNewPage('Snippet List', '/list')); + }, []); + + return ( + <> + + +

Snippet List

+

+ Click on a snippet’s name to view its code or a tag name to view all + snippets in that category. +

+ {tags.map(tag => ( + <> +

+ + {capitalize(tag)} + +

+ {snippets + .filter(snippet => snippet.tags[0] === tag) + .map(snippet => ( + + ))} + + ))} +
+ {staticPages.map(page => ( + + {page.title} + + )} + > +

{page.description}

+
+ ))} +
+ + ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(ListPage); + +export const listPageQuery = graphql` + query snippetListing { + snippetDataJson(meta: { type: { eq: "snippetListingArray" } }) { + data { + id + title + attributes { + tags + text + } + } + } + allMarkdownRemark( + limit: 1000 + sort: { fields: [frontmatter___title], order: ASC } + ) { + totalCount + edges { + node { + id + html + rawMarkdownBody + fields { + slug + } + frontmatter { + title + tags + } + } + } + } + } +`; diff --git a/src/docs/pages/search.js b/src/docs/pages/search.js new file mode 100644 index 000000000..33617e9b1 --- /dev/null +++ b/src/docs/pages/search.js @@ -0,0 +1,144 @@ +import React from 'react'; +import { graphql } from 'gatsby'; +import { connect } from 'react-redux'; +import { pushNewPage, pushNewQuery } from '../state/app'; + +import Shell from '../components/Shell'; +import Meta from '../components/Meta'; +import Search from '../components/Search'; +import SnippetCard from '../components/SnippetCard'; + +import { getRawCodeBlocks as getCodeBlocks } from '../util'; + +// =================================================== +// Search page +// =================================================== +const SearchPage = props => { + const snippets = props.data.snippetDataJson.data.map(snippet => ({ + title: snippet.title, + html: props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.html, + tags: snippet.attributes.tags, + text: snippet.attributes.text, + id: snippet.id, + code: getCodeBlocks( + props.data.allMarkdownRemark.edges.find( + v => v.node.frontmatter.title === snippet.title, + ).node.rawMarkdownBody, + ).code, + })); + + const [searchQuery, setSearchQuery] = React.useState(props.searchQuery); + const [searchResults, setSearchResults] = React.useState(snippets); + + React.useEffect(() => { + props.dispatch(pushNewQuery(searchQuery)); + let q = searchQuery.toLowerCase(); + let results = snippets; + if (q.trim().length) + results = snippets.filter( + v => + v.tags.filter(t => t.indexOf(q) !== -1).length || + v.title.toLowerCase().indexOf(q) !== -1, + ); + setSearchResults(results); + }, [searchQuery]); + + React.useEffect(() => { + props.dispatch(pushNewPage('Search', '/search')); + }, []); + + return ( + <> + + + +

Click on a snippet's name to view its code.

+ {/* Display page background or results depending on state */} + {searchQuery.length === 0 ? ( + <> +
+

+ Start typing a keyword to see matching snippets. +

+
+ + ) : searchResults.length === 0 ? ( + <> +
+

+ No results found +
+

+

+ We couldn't find any results for the keyword{' '} + {searchQuery}. +

+
+ + ) : ( + <> +

Search results

+ {searchResults.map(snippet => ( + + ))} + + )} +
+ + ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(SearchPage); + +export const searchPageQuery = graphql` + query searchSnippetList { + snippetDataJson(meta: { type: { eq: "snippetListingArray" } }) { + data { + id + title + attributes { + tags + text + } + } + } + allMarkdownRemark( + limit: 1000 + sort: { fields: [frontmatter___title], order: ASC } + ) { + totalCount + edges { + node { + id + html + rawMarkdownBody + fields { + slug + } + frontmatter { + title + tags + } + } + } + } + } +`; diff --git a/src/docs/state/ReduxWrapper.js b/src/docs/state/ReduxWrapper.js new file mode 100644 index 000000000..5daacf556 --- /dev/null +++ b/src/docs/state/ReduxWrapper.js @@ -0,0 +1,13 @@ +import React from 'react'; +import { Provider } from 'react-redux'; +import { createStore as reduxCreateStore } from 'redux'; +import rootReducer from '.'; + +const createStore = () => reduxCreateStore(rootReducer); + +// =================================================== +// Wrapper for Gatsby +// =================================================== +export default ({ element }) => ( + {element} +); diff --git a/src/docs/state/app.js b/src/docs/state/app.js new file mode 100644 index 000000000..546e6fde4 --- /dev/null +++ b/src/docs/state/app.js @@ -0,0 +1,49 @@ +// Defalt state +const initialState = { + isDarkMode: false, + lastPageTitle: 'Home', + lastPageUrl: '/', + searchQuery: '', +}; + +// Actions +const TOGGLE_DARKMODE = 'TOGGLE_DARKMODE'; +const PUSH_NEW_PAGE = 'PUSH_NEW_PAGE'; +const PUSH_NEW_QUERY = 'PUSH_NEW_QUERY'; +export const toggleDarkMode = isDarkMode => ({ + type: TOGGLE_DARKMODE, + isDarkMode, +}); +export const pushNewPage = (pageTitle, pageUrl) => ({ + type: PUSH_NEW_PAGE, + pageTitle, + pageUrl, +}); +export const pushNewQuery = query => ({ + type: PUSH_NEW_QUERY, + query, +}); + +// Reducer +export default (state = initialState, action) => { + switch (action.type) { + case TOGGLE_DARKMODE: + return { + ...state, + isDarkMode: action.isDarkMode, + }; + case PUSH_NEW_PAGE: + return { + ...state, + lastPageTitle: action.pageTitle, + lastPageUrl: action.pageUrl, + }; + case PUSH_NEW_QUERY: + return { + ...state, + searchQuery: action.query, + }; + default: + return state; + } +}; diff --git a/src/docs/state/index.js b/src/docs/state/index.js new file mode 100644 index 000000000..1ee96d387 --- /dev/null +++ b/src/docs/state/index.js @@ -0,0 +1,4 @@ +import { combineReducers } from 'redux'; +import app from './app'; + +export default combineReducers({ app }); diff --git a/src/docs/styles/_button.scss b/src/docs/styles/_button.scss new file mode 100644 index 000000000..689b7e96d --- /dev/null +++ b/src/docs/styles/_button.scss @@ -0,0 +1,85 @@ +// =================================================== +// Buttons +// =================================================== +.button, a.button { + color: var(--button-fore-color); + font-weight: 500; + font-size: 1.125rem; + line-height: 1.4; + transition: 0.3s ease all; + padding: 0.625rem 0.875rem; + margin-top: 0.75rem; + border-radius: 1rem; + display: inline-block; + box-shadow: 0px 4px 8px var(--button-shadow-color); + border: none; + cursor: pointer; + &:hover, &:focus { + box-shadow: 0px 8px 16px var(--button-shadow-color); + text-decoration: none; + outline: none; + } + &.button-a { + background: var(--button-back-color-a); + } + &.button-b { + background: var(--button-back-color-b); + } + svg { + vertical-align: sub; + } + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1.375rem; + line-height: 1.35; + } +} + +// Home button (404 page) +.button.button-home { + @media screen and (min-width: $layout-large-breakpoint) { + margin-top: 1.375rem; + } +} + +// Copy and share buttons (snippet card) +.button.button-copy { + position: absolute; + top: -32px; + right: 24px; + padding: 0.5rem 0.625rem; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23ffffff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-clipboard' %3E%3Cpath d='M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2'%3E%3C/path%3E%3Crect x='8' y='2' width='8' height='4' rx='1' ry='1'%3E%3C/rect%3E%3C/svg%3E"); + background-repeat: no-repeat; + background-position: center; + width: 44px; + height: 44px; +} +.button.button-social-sh { + position: absolute; + top: -32px; + right: 80px; + padding: 0.5rem 0.625rem; +} + +// Show/hide examples button (snippet card) +.button.button-example-toggler { + position: relative; + margin: -2rem 0px -1rem 0px; + background: var(--pre-back-color); + border-radius: 0px 0px 0.125rem 0.125rem; + width: calc(100%); + text-align: left; + display: block; + font-size: 0.875rem; + line-height: 1.35; + text-transform: uppercase; + font-weight: 300; + color: var(--button-example-toggler-fore-color); + box-shadow: none; + font-family: 'Roboto Mono', Menlo, Consolas, monospace; + &:hover, &:focus { + box-shadow: none; + } + svg { + margin-right: 0.125rem; + } +} \ No newline at end of file diff --git a/src/docs/styles/_card.scss b/src/docs/styles/_card.scss new file mode 100644 index 000000000..39004f99b --- /dev/null +++ b/src/docs/styles/_card.scss @@ -0,0 +1,174 @@ +// =================================================== +// Cards +// =================================================== +.card { + position: relative; + transition: all 0.3s ease; + margin: 1rem 1.25rem; + background: var(--card-back-color); + color: var(--card-fore-color); + box-shadow: 0px 0px 1px var(--card-shadow-color-a), 0px 6px 12px var(--card-shadow-color-b); + border-radius: 0.125rem; + padding: 1rem; + .card-title { + font-size: 1.125rem; + line-height: 1.375; + font-weight: 500; + margin: 0px 0px 0.125rem; + a, a:link, a:visited { + font-weight: 500; + transition: 0.3s ease all; + color: var(--card-fore-color); + } + } + .card-description { + margin: 0.125rem -0.5rem 0.125rem; + font-size: 0.875rem; + color: var(--card-fore-color-light); + line-height: 1.35; + font-weight: 500; + } + .card-bottom { + position: relative; + margin-left: -1rem; + margin-right: -1rem; + border-radius: 0.125rem; + border-top-left-radius: 22px; + } + .card-code { + margin: 1.5rem 0px -1rem 0px; + background: var(--pre-back-color); + width: calc(100% - 36px); + border-radius: 1.375rem 0px 0.125rem 0.125rem; + line-height: 1.15; + padding: 2.25rem 1.125rem 2.25rem; + + .card-code { + position: relative; + margin-top: 0; + border-top: 1px solid var(--button-example-toggler-fore-color); + border-top-left-radius: 0; + } + &.language-css, &.language-jsx { + &::before { + position: absolute; + top: 0.625rem; + left: 1.25rem; + display: block; + color: var(--button-example-toggler-fore-color); + } + } + &.language-css { + &::before { + content: 'CSS'; + } + } + &.language-jsx { + &::before { + content: 'JSX'; + } + } + } + .card-examples { + transition: all 0.3s ease; + position: relative; + margin: 0.5rem 0px -1rem 0px; + background: var(--pre-back-color); + width: calc(100% - 52px); + border-radius: 0px 0px 0.125rem 0.125rem; + line-height: 1.15; + padding: 0.5rem 1.125rem 2.25rem 2.125rem; + &::before { + display: block; + content: ''; + position: absolute; + left: 21px; + top: 0; + width: 1px; + opacity: 0.75; + height: calc(100% - 24px); + background: var(--button-example-toggler-fore-color); + } + } + &.short { + .card-bottom { + display: none; + @media screen and (min-width: $layout-large-breakpoint) { + display: block; + } + } + } + &:not(.short) { + background: linear-gradient(to bottom, var(--card-back-color) 0px, var(--card-back-color) calc(100% - 17px), var(--pre-back-color) calc(100% - 16px)); + } +} + +// Card expertise corners +.card-corner { + box-sizing: border-box; + position: absolute; + top: 24px; + right: 16px; + width: 0.5rem; + height: 0.5rem; + border-radius: 0.5rem; + background: var(--corner-color); + &.beginner { + --corner-color: var(--beginner-color); + } + &.intermediate { + --corner-color: var(--intermediate-color); + } + &.advanced { + --corner-color: var(--advanced-color); + } + &.intermediate, &.advanced { + &::before { + display: block; + position: absolute; + content: ''; + top: 0px; + right: 12px; + width: 0.5rem; + height: 0.5rem; + border-radius: 0.5rem; + background: var(--corner-color); + } + } + &.advanced { + &::after { + display: block; + position: absolute; + content: ''; + top: 0px; + right: 24px; + width: 0.5rem; + height: 0.5rem; + border-radius: 0.5rem; + background: var(--corner-color); + } + } +} + +// Tags +:not(.token).tag { + transition: 0.3s ease all; + border: 2px solid var(--tag-border-color); + border-radius: 0.25rem; + color: var(--tag-fore-color); + text-transform: uppercase; + margin: 0px 0.375rem 0.25rem 0px; + display: inline-block; + padding: 0.125rem 0.25rem; + letter-spacing: 0.25px; + font-size: 0.625rem; + line-height: 1.4; + font-weight: 500; + &:first-of-type { + margin-top: 0.375rem; + } +} + +// Animation for card example +.roll-up-height { + transition: height 0.3s ease-in-out; +} \ No newline at end of file diff --git a/src/docs/styles/_code.scss b/src/docs/styles/_code.scss new file mode 100644 index 000000000..5ceccf71e --- /dev/null +++ b/src/docs/styles/_code.scss @@ -0,0 +1,121 @@ +// Style code +code, kbd, pre { + font-size: 0.875em; +} +code, kbd, pre, code *, pre *, kbd *, code[class*="language-"], pre[class*="language-"] { + font-family: 'Roboto Mono', Menlo, Consolas, monospace; +} + +code { + background: var(--code-back-color); + color: var(--code-fore-color); + padding: 0.125rem 0.375rem; + border-radius: 0.125rem; +} +pre { + overflow: auto; // Responsiveness + background: var(--pre-back-color); + color: var(--pre-fore-color); + padding: 0.375rem; + margin: 0.5rem; + border: 0; +} + +code[class*="language-"], pre[class*="language-"] { + color: var(--pre-fore-color); + + text-align: left; + white-space: pre; + word-spacing: normal; + word-break: normal; + word-wrap: normal; + line-height: 1.8; + + -moz-tab-size: 2; + -o-tab-size: 2; + tab-size: 2; + + -webkit-hypens: none; + -moz-hyphens: none; + -ms-hyphens: none; + hyphens: none; +} + +pre[class*="language-"] { + padding: 1rem; + overflow: auto; + margin: 0.5rem 0; + white-space: pre-wrap; +} + +pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection, +code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection { + background: var(--pre-selected-color); +} + +pre[class*="language-"]::selection, pre[class*="language-"] ::selection, +code[class*="language-"]::selection, code[class*="language-"] ::selection { + background: var(--pre-selected-color); +} + +:not(pre) > code[class*="language-"] { + padding: .1em; + border-radius: .3em; + white-space: normal; +} + +.namespace { + opacity: .7; +} + +.token { + &.comment, &.prolog, &.doctype, &.cdata { + color: var(--token-color-a); + } + &.punctuation { + color: var(--token-color-b); + } + &.property, &.tag, &.boolean, &.constant, &.symbol, &.deleted, &.function { + color: var(--token-color-c); + } + &.number, &.class-name { + color: var(--token-color-d); + } + &.selector, &.attr-name, &.string, &.char, &.builtin, &.inserted { + color: var(--token-color-e); + } + &.operator, &.entity, &.url, &.atrule, &.attr-value, &.keyword, &.interpolation-punctuation { + color: var(--token-color-f); + } + &.regex { + color: var(--token-color-g); + } + &.important, &.variable { + color: var(--token-color-h); + } + &.italic, &.comment { + font-style: italic; + } + &.important, &.bold { + font-weight: 500; + } + &.entity { + cursor: help; + } +} +.language-css .token.string, .style .token.string { + color: var(--token-color-f); +} + +p > code, a > code { + &, &[class*="language-"] { + color: var(--code-fore-color); + background: var(--code-back-color); + &::-moz-selection, & ::-moz-selection { + background: var(--code-selected-color); + } + &::selection, & ::selection { + background: var(--code-selected-color); + } + } +} \ No newline at end of file diff --git a/src/docs/styles/_colors.scss b/src/docs/styles/_colors.scss new file mode 100644 index 000000000..38ad0d519 --- /dev/null +++ b/src/docs/styles/_colors.scss @@ -0,0 +1,140 @@ +:root { + // Interface color palette + --back-color: #F5F6FA; + --back-color-dark: #D7DDF3; + --fore-color: #404454; + --fore-color-light: #575E7A; + --fore-color-lighter: #666E8F; + --fore-color-dark: #1F253D; + --fore-color-darker: #060709; + + // Scrollbar + --scrollbar-back-color: #D7DDF3; + --scrollbar-fore-color: #666E8F; + + // Menu color palette + --menu-back-color: #FFFFFF; + --menu-border-color: #E4E6EC; + --menu-fore-color: #53586A; + --menu-active-fore-color: #2747C7; + + // Card corner palette + --beginner-color: #7CB342; + --intermediate-color: #FFB300; + --advanced-color: #D66361; + + // Search color palette + --search-back-color: #FFFFFF; + --search-fore-color: #0D0E17; + --search-placeholder-color: #C5C6CD; + --search-shadow-color: rgba(0, 32, 128, 0.1); + --search-shadow-focus-color: rgba(0, 32, 128, 0.17); + + // Button color palette + --button-back-color-a: #3B3EFC; + --button-back-color-b: #DC325F; + --button-fore-color: #FFFFFF; + --button-shadow-color: rgba(0, 0, 0, 0.25); + --button-shadow-focus-color: rgba(0, 0, 0, 0.29); + --button-example-toggler-fore-color: #607d8b; + + // Card color palette + --card-back-color: #FFFFFF; + --card-fore-color: #212121; + --card-fore-color-light: #424242; + --card-shadow-color-a: rgba(240, 242, 247, 0.1); + --card-shadow-color-b: rgba(0, 32, 128, 0.1); + + // Pre & Code color palette + --pre-fore-color: #e57373; + --pre-back-color: #1e253d; + --pre-selected-color: #041248; + + // Token color palette + --token-color-a: #7f99a5; // Comments + --token-color-b: #bdbdbd; // Punctuation + --token-color-c: #64b5f6; // Functions + --token-color-d: #ff8f00; // Numbers + --token-color-e: #c5e1a5; // Strings + --token-color-f: #ce93d8; // Keywords + --token-color-g: #26c6da; // Regular expressions + --token-color-h: #e57373; // Variables + + // Tag color palette + --tag-border-color: #D7DDF3; + --tag-fore-color: #616B8F; + + // Toast color palette + --toast-back-color: #05A864; + --toast-fore-color: #FFFFFF; + --toast-shadow-color: rgba(0, 32, 128, 0.26); + + // Link color palette + --a-link-color: #0277bd; + --a-visited-color: #01579b; + + // Code color palette + --code-fore-color: #0324AB; + --code-back-color: #EDF0FC; + --code-selected-color: #BDEDFE; +} + +// Dark mode colors +.page-container.dark { + // Interface color palette + --back-color: #2A314C; + --back-color-dark: #8993BE; + --fore-color: #ABAFBF; + --fore-color-light: #858CA8; + --fore-color-lighter: #707899; + --fore-color-dark: #B4BCD9; + --fore-color-darker: #FCFCFD; + + // Scrollbar + --scrollbar-back-color: #434E76; + --scrollbar-fore-color: #707899; + + // Menu color palette + --menu-back-color: #434E76; + --menu-border-color: #13151B; + --menu-fore-color: #959AAC; + --menu-active-fore-color: #CDD4EF; + + // Card corner palette remains unchanged for consistency + + // Search color palette + --search-back-color: #434E76; + --search-fore-color: #E8E9F2; + --search-placeholder-color: #999EBD; + --search-shadow-color: rgba(1, 8, 30, 0.24); + --search-shadow-focus-color: rgba(1, 8, 30, 0.31); + + // Button color palette remains unchanged for consistency + + // Card color palette + --card-back-color: #434E76; + --card-fore-color: #F0F0F0; + --card-fore-color-light: #D6D6D6; // previously C0C0C0, careful + --card-shadow-color-b: rgba(1, 8, 30, 0.24); + + // Pre & Code color palette remains unchanged for consistency + + // Token color palette remains unchanged for consistency + + // Tag color palette + --tag-border-color: #2A3765; + --tag-fore-color: #BEC1CB; // previously 999DAD, careful + + // Toast color palette + --toast-shadow-color: rgba(1, 8, 30, 0.44); + + // Link color palette + --a-link-color: #6DC7FD; + --a-visited-color: #5DB7FE; + + // Code color palette + --code-fore-color: #d1dafe; + --code-back-color: #4f5fa0; + --code-selected-color: #0dbcfb; + +} \ No newline at end of file diff --git a/src/docs/styles/_fonts.scss b/src/docs/styles/_fonts.scss new file mode 100644 index 000000000..42e20aed6 --- /dev/null +++ b/src/docs/styles/_fonts.scss @@ -0,0 +1,89 @@ +// Load external fonts - progressive loading should help alleviate performance issues +@font-face { + font-family: 'Roboto Mono'; + font-style: normal; + font-weight: 400; + font-display: swap; + src: local('Roboto Mono'), local('RobotoMono-Regular'), url(../../../assets/RobotoMono-Regular.woff2) format('woff2'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Roboto Mono'; + font-style: italic; + font-weight: 400; + font-display: swap; + src: local('Roboto Mono Italic'), local('RobotoMono-Italic'), url(../../../assets/RobotoMono-Italic.woff2) format('woff2'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Roboto Mono'; + font-style: normal; + font-weight: 500; + src: local('Roboto Mono Medium'), local('RobotoMono-Medium'), url(../../../assets/RobotoMono-Medium.woff2) format('woff2'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; + font-display: swap; +} +@font-face { + font-family: 'Noto Sans'; + font-style: normal; + font-weight: 300; + font-display: swap; + src: local('Noto Sans Light'), local('NotoSans-Light'), url(../../../assets/NotoSans-Light.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: italic; + font-weight: 300; + font-display: swap; + src: local('Noto Sans LightItalic'), local('NotoSans-LightItalic'), url(../../../assets/NotoSans-LightItalic.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: normal; + font-weight: 400; + font-display: swap; + src: local('Noto Sans'), local('NotoSans-Regular'), url(../../../assets/NotoSans-Regular.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: italic; + font-weight: 400; + font-display: swap; + src: local('Noto Sans Italic'), local('NotoSans-Italic'), url(../../../assets/NotoSans-Italic.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: normal; + font-weight: 500; + font-display: swap; + src: local('Noto Sans Medium'), local('NotoSans-Medium'), url(../../../assets/NotoSans-Medium.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: italic; + font-weight: 500; + font-display: swap; + src: local('Noto Sans Medium Italic'), local('NotoSans-MediumItalic'), url(../../../assets/NotoSans-MediumItalic.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: normal; + font-weight: 600; + font-display: swap; + src: local('Noto Sans SemiBold'), local('NotoSans-SemiBold'), url(../../../assets/NotoSans-SemiBold.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} +@font-face { + font-family: 'Noto Sans'; + font-style: italic; + font-weight: 600; + font-display: swap; + src: local('Noto Sans SemiBold Italic'), local('NotoSans-SemiBoldItalic'), url(../../../assets/NotoSans-SemiBoldItalic.ttf) format('truetype'); + unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; +} \ No newline at end of file diff --git a/src/docs/styles/_layout.scss b/src/docs/styles/_layout.scss new file mode 100644 index 000000000..7057cd837 --- /dev/null +++ b/src/docs/styles/_layout.scss @@ -0,0 +1,340 @@ +// =================================================== +// Layout +// =================================================== +// Grid container +.page-container { + overflow: hidden; + transition: 0.3s ease all; + background: var(--back-color); + display: grid; + width: 100vw; + height: 100vh; + grid-template-areas: "content" "menu"; + grid-template-columns: 100%; + grid-template-rows: calc(100vh - 62px) 62px; + // Medium screen size (mobile landscape, tablet) + @media screen and (min-width: $layout-medium-breakpoint) { + grid-template-areas: "menu content"; + grid-template-columns: 62px calc(100vw - 62px); + grid-template-rows: 100%; + } + // Large screen size (desktop, laptop) + @media screen and (min-width: $layout-large-breakpoint) { + grid-template-areas: "menu . content ."; + grid-template-columns: 62px calc((100vw - 830px) / 2) 768px calc((100vw - 830px) / 2); + } +} +// Menu container +header.menu { + grid-area: menu; +} +// Content container +.content { + transition: 0.3s ease all; + grid-area: content; + overflow: auto; + background: var(--back-color); + &::-webkit-scrollbar-track { + background-color: var(--scrollbar-back-color); + margin: 0.5rem 0; + border-radius: 0.125rem; + } + &::-webkit-scrollbar { + width: 4px; + background: transparent; + } + &::-webkit-scrollbar-thumb { + background-color: var(--scrollbar-fore-color); + border: 1px solid var(--scrollbar-fore-color-lighter); + border-radius: 0.125rem; + } +} + +// Website title +h1.website-title { + transition: 0.3s ease all; + font-size: 0.875rem; + font-weight: 500; + color: var(--fore-color-lighter); + line-height: 1.5; + position: relative; + top: 4px; + margin: 1.5rem 1.25rem 0.125rem; + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1rem; + line-height: 1.375; + } +} +// Website logo +img.website-logo { + transition: 0.3s ease all; + position: absolute; + top: 8px; + right: 0px; + width: 48px; + height: 48px; +} +// Homepage logo +.index-logo { + transition: 0.3s ease all; + display: block; + margin: 1.5rem 1.25rem 0.5rem; + vertical-align: middle; + @media screen and (min-width: 144px) { + max-width: 128px; + margin: 1.5rem auto 0.5rem; + } + @media screen and (min-width: $layout-medium-breakpoint) { + display: inline-block; + margin: 1.5rem 2rem 0.5rem 1.25rem; + } +} +// Homepage title +.index-title { + transition: 0.3s ease all; + font-size: 2rem; + color: var(--fore-color-dark); + @media screen and (min-width: $layout-medium-breakpoint) { + display: inline-block; + } + margin: 0.75rem 1.25rem; + text-align: center; +} +// Homepage subtitle +.index-sub-title { + transition: 0.3s ease all; + font-size: 0.875rem; + line-height: 1.5; + margin: 1rem 1.25rem 1.25rem; + color: var(--fore-color); + text-align: center; + @media screen and (min-width: $layout-medium-breakpoint) { + font-size: 1rem; + } +} + +// Page title +.page-title { + font-size: 2.25rem; + font-weight: 400; + line-height: 1.36; + letter-spacing: 0.03em; + color: var(--fore-color-darker); + margin: 0 1.25rem; + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 2.5rem; + line-height: 1.35; + } +} +// Page subtitle +.page-sub-title { + transition: 0.3s ease all; + font-size: 1.125rem; + line-height: 1.35; + margin: 1rem 1.25rem 0.5rem; + color: var(--fore-color); + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1.25rem; + } +} +// Page light subtitle +p.light-sub { + transition: 0.3s ease all; + color: var(--fore-color-light); + font-size: 0.875rem; + line-height: 1.5; + margin: 0.125rem 1.25rem 0px; + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1rem; + line-height: 1.375; + } +} +// Category/tag title +.tag-title { + transition: 0.3s ease all; + font-size: 1.125rem; + color: var(-fore-color-dark); + line-height: 1.375; + a { + &, &:link, &:visited { + color: var(--fore-color-dark); + } + } + font-weight: 400; + cursor: pointer; + margin: 1.5rem 1.25rem 0.5rem; +} + +// Return to previous page link +a.link-back { + transition: 0.3s ease all; + font-size: 1.125rem; + line-height: 1.35; + display: block; + margin: 1rem 1.25rem 1.5rem; + font-weight: 500; + &, &:link, &:visited { + color: var(--fore-color-dark); + } + &:hover, &:focus { + text-decoration: none; + } + svg { + vertical-align: middle; + } +} + +// About page maintainers card +.flex-row { + display: flex; + flex: 0 1 auto; + flex-flow: row wrap; + .flex-item { + flex: 0 0 auto; + max-width: calc(50% - 24px); + flex-basis: calc(50% - 24px); + margin: 12px; + @media screen and (min-width: $layout-large-breakpoint) { + max-width: calc(25% - 24px); + flex-basis: calc(25% - 24px); + } + .media-section { + max-width: 100%; + height: auto; + border-radius: 0.5rem; + } + .button-section { + font-size: 0.875rem; + font-weight: 600; + text-align: center; + width: 100%; + display: block; + &, &:link, &:visited { + font-weight: 600; + color: var(--card-fore-color); + } + } + } +} + +// Page background graphic +.page-graphic { + position: relative; + box-sizing: border-box; + transition: all 0.3s ease; + margin-top: 100px; + width: 100%; + height: calc(50vmin); + &::before { + top: 0; + right: 27.5vmin; + position: absolute; + content: ''; + width: 45vmin; + height: 44vmin; + background-position-x: 52.5%, center; + background-position-y: 1%, top; + background-repeat: no-repeat; + background-size: 45vmin, 44vmin; + } + padding-top: 46vmin; + text-align: center; + @media screen and (orientation: landscape) and (max-height: calc(#{$layout-medium-breakpoint} - 1px)) { + margin-top: 2rem; + padding-top: 38vmin; + height: 40vmin; + &::before { + right: calc(50vw - 45vmin / 2 - 31px); + } + } + @media screen and (min-width: $layout-large-breakpoint) { + padding-top: 2vmin; + padding-right: 400px; + &::before { + background-size: 395px, 393px; + height: 400px; + width: 400px; + right: 1.125rem; + margin-top: -2vmin; + background-position-x: 95.5%, 93%; + } + } +} + +// Empty page text +.empty-page-text { + transition: color 0.3s ease, background 0.3s ease; + text-align: center; + margin: 2.25rem auto 0.75rem; + max-width: 200px; + font-size: 1rem; + line-height: 1.5; + color: var(--fore-color-darker); + font-weight: 400; + @media screen and (min-width: $layout-medium-breakpoint) { + max-width: 400px; + } + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1.75rem; + line-height: 1.35; + margin: 2.25rem auto 1.375rem 1.25rem; + &.search-page-text { + margin-top: 12vmin; + font-size: 1.375rem; + line-height: 1.375; + } + } +} +.empty-page-subtext { + transition: all 0.3s ease; + text-align: center; + font-size: 14px; + font-weight: 400; + line-height: 1.5; + max-width: 200px; + color: var(--fore-color-darker); + margin: 0.5rem auto; + @media screen and (min-width: $layout-medium-breakpoint) { + max-width: 256px; + } + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1.125rem; + line-height: 1.375; + } +} +// Background graphic styles and dark mode +.search-empty::before { + background-image: url("data:image/svg+xml,%3Csvg width='154' height='148' viewBox='0 0 154 148' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cline x1='72.7688' y1='68.1962' x2='88.5602' y2='83.9877' stroke='%23575E7A' stroke-width='2'/%3E%3Crect x='97.8234' y='75.055' width='76.9574' height='23.2664' rx='11.6332' transform='rotate(45 97.8234 75.055)' stroke='%23575E7A' stroke-width='2'/%3E%3Cpath d='M81.3085 50.7431C81.9744 47.8236 82.3261 44.7844 82.3261 41.6631C82.3261 35.0791 80.7613 28.8607 77.9834 23.3593' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M56.2702 3.70245C51.7367 1.95686 46.8116 1 41.663 1C19.2055 1 1 19.2055 1 41.663C1 64.1206 19.2055 82.3261 41.663 82.3261C59.2695 82.3261 74.2624 71.1364 79.9182 55.4806' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M62.1442 6.52702C65.6967 8.6023 68.9061 11.2009 71.6667 14.2172' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3C/svg%3E"), url("data:image/svg+xml,%3Csvg width='152' height='150' viewBox='0 0 152 150' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M147.38 72.8499C153.437 95.1096 155.456 105.228 141.323 129.511C127.191 153.794 94.8556 149.747 72.6806 149.747C32.5402 149.747 0 117.131 0 76.8971C0 36.6632 34.5591 0 74.6995 0C114.84 0 141.323 50.5902 147.38 72.8499Z' fill='%23D7DDF3'/%3E%3C/svg%3E"); +} +.search-no-results::before { + background-image: url("data:image/svg+xml,%3Csvg width='154' height='148' viewBox='0 0 154 148' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cline x1='72.7688' y1='68.1962' x2='88.5602' y2='83.9877' stroke='%23575E7A' stroke-width='2'/%3E%3Crect x='97.8234' y='75.055' width='76.9574' height='23.2664' rx='11.6332' transform='rotate(45 97.8234 75.055)' stroke='%23575E7A' stroke-width='2'/%3E%3Cpath d='M81.3085 50.7432C81.9744 47.8236 82.3261 44.7844 82.3261 41.6631C82.3261 35.0792 80.7613 28.8607 77.9834 23.3593' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M56.2702 3.70245C51.7367 1.95686 46.8116 1 41.663 1C19.2055 1 1 19.2055 1 41.663C1 64.1206 19.2055 82.3261 41.663 82.3261C59.2695 82.3261 74.2624 71.1364 79.9182 55.4806' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M62.1442 6.52701C65.6967 8.60229 68.9061 11.2009 71.6667 14.2172' stroke='%23575E7A' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M11.3086 38.2034C11.3086 38.2034 13.5167 41.5575 16.9242 41.3193C20.3318 41.081 22.0516 37.4522 22.0516 37.4522M18.1449 58.7766C18.1449 58.7766 23.8094 54.872 31.061 54.3649C38.3125 53.8578 43.9281 56.9737 43.9281 56.9737M34.2526 36.599C34.2526 36.599 36.2089 39.9708 39.8682 39.7149C43.5276 39.459 44.9956 35.8478 44.9956 35.8478' stroke='%23575E7A' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/svg%3E%0A"), url("data:image/svg+xml,%3Csvg width='152' height='150' viewBox='0 0 152 150' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M147.38 72.8499C153.437 95.1096 155.456 105.228 141.323 129.511C127.191 153.794 94.8556 149.747 72.6806 149.747C32.5402 149.747 0 117.131 0 76.8971C0 36.6632 34.5591 0 74.6995 0C114.84 0 141.323 50.5902 147.38 72.8499Z' fill='%23D7DDF3'/%3E%3C/svg%3E"); +} +.page-not-found::before { + background-image: url("data:image/svg+xml,%3Csvg width='160' height='109' viewBox='0 0 160 109' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M1 7.99999C1 4.134 4.13401 1 8 1H95.1429H152C155.866 1 159 4.13401 159 8V100.571C159 104.437 155.866 107.571 152 107.571H8C4.13401 107.571 1 104.437 1 100.571V7.99999Z' stroke='%23575E7A' stroke-width='2'/%3E%3Cline x1='1' y1='17.8571' x2='83.5714' y2='17.8571' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='100.429' y1='17.8571' x2='116.714' y2='17.8571' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='128.429' y1='17.8571' x2='159' y2='17.8571' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Ccircle cx='8.57138' cy='9.7142' r='1.85714' stroke='%23575E7A' stroke-width='2'/%3E%3Ccircle cx='17.7142' cy='9.7142' r='1.85714' stroke='%23575E7A' stroke-width='2'/%3E%3Ccircle cx='26.8573' cy='9.7142' r='1.85714' stroke='%23575E7A' stroke-width='2'/%3E%3Cline x1='33.9856' y1='38.2856' x2='41.4608' y2='45.7608' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='34.4762' y1='45.761' x2='41.9513' y2='38.2858' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='105.414' y1='38.2856' x2='112.889' y2='45.7608' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='105.905' y1='45.761' x2='113.38' y2='38.2858' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M49.8545 69.0772C49.8545 69.0772 57.5257 73.6485 72.1402 73.6485C86.7117 73.6485 94.4259 69.0771 94.4259 69.0771' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M72.1526 78.5698C72.3093 86.3002 68.3437 92.6498 63.2953 92.7521C58.2469 92.8544 54.0273 86.6706 53.8707 78.9402C53.8129 76.0901 54.3155 73.4277 55.2261 71.1969' stroke='%23575E7A' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M64.6687 73.7268C64.8334 73.1997 64.5396 72.6388 64.0125 72.4741C63.4853 72.3093 62.9245 72.6031 62.7597 73.1303L64.6687 73.7268ZM61.8707 88.7359C61.9615 89.2807 62.4768 89.6487 63.0215 89.5579C63.5663 89.4671 63.9343 88.9519 63.8435 88.4071L61.8707 88.7359ZM62.7597 73.1303C61.2791 77.8683 60.9909 83.4569 61.8707 88.7359L63.8435 88.4071C63.009 83.4002 63.2922 78.1317 64.6687 73.7268L62.7597 73.1303Z' fill='%23575E7A'/%3E%3C/svg%3E%0A"), url("data:image/svg+xml,%3Csvg width='172' height='170' viewBox='0 0 172 170' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M85.7456 16.9208C110.886 -6.48267 132.959 -4.28052 156.498 15.4794C180.037 35.2393 174.047 84.4687 153.005 119.028C128.204 159.761 84.2197 174.845 40.8539 167.344C-2.51188 159.842 -6.55002 107.678 7.88005 65.9713C22.3101 24.2642 60.6055 40.3243 85.7456 16.9208Z' fill='%23D7DDF3'/%3E%3C/svg%3E%0A"); + background-position-x: 53.5%, center; + background-position-y: 8.5%, top; + background-size: 41vmin, 44vmin; + &::before { + background-size: 395px, 393px; + height: 400px; + width: 400px; + right: 1.125rem; + margin-top: -15vmin; + background-position-x: 95.5%, 93%; + } + @media screen and (min-width: $layout-large-breakpoint) { + background-size: 367px, 393px; + background-position-x: 96.5%, 93%; + } +} +.page-container.dark { + .search-empty::before { + background-image: url("data:image/svg+xml,%3Csvg width='154' height='148' viewBox='0 0 154 148' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cline x1='72.7688' y1='68.1962' x2='88.5602' y2='83.9877' stroke='%238993BE' stroke-width='2'/%3E%3Crect x='97.8234' y='75.055' width='76.9574' height='23.2664' rx='11.6332' transform='rotate(45 97.8234 75.055)' stroke='%238993BE' stroke-width='2'/%3E%3Cpath d='M81.3085 50.7431C81.9744 47.8236 82.3261 44.7844 82.3261 41.6631C82.3261 35.0791 80.7613 28.8607 77.9834 23.3593' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M56.2702 3.70245C51.7367 1.95686 46.8116 1 41.663 1C19.2055 1 1 19.2055 1 41.663C1 64.1206 19.2055 82.3261 41.663 82.3261C59.2695 82.3261 74.2624 71.1364 79.9182 55.4806' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M62.1442 6.52702C65.6967 8.6023 68.9061 11.2009 71.6667 14.2172' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3C/svg%3E"), url("data:image/svg+xml,%3Csvg width='152' height='150' viewBox='0 0 152 150' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M147.38 72.8499C153.437 95.1096 155.456 105.228 141.323 129.511C127.191 153.794 94.8556 149.747 72.6806 149.747C32.5402 149.747 0 117.131 0 76.8971C0 36.6632 34.5591 0 74.6995 0C114.84 0 141.323 50.5902 147.38 72.8499Z' fill='%23555C7C'/%3E%3C/svg%3E"); + } + .search-no-results::before { + background-image: url("data:image/svg+xml,%3Csvg width='154' height='148' viewBox='0 0 154 148' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cline x1='72.7688' y1='68.1962' x2='88.5602' y2='83.9877' stroke='%238993BE' stroke-width='2'/%3E%3Crect x='97.8234' y='75.055' width='76.9574' height='23.2664' rx='11.6332' transform='rotate(45 97.8234 75.055)' stroke='%238993BE' stroke-width='2'/%3E%3Cpath d='M81.3085 50.7432C81.9744 47.8236 82.3261 44.7844 82.3261 41.6631C82.3261 35.0792 80.7613 28.8607 77.9834 23.3593' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M56.2702 3.70245C51.7367 1.95686 46.8116 1 41.663 1C19.2055 1 1 19.2055 1 41.663C1 64.1206 19.2055 82.3261 41.663 82.3261C59.2695 82.3261 74.2624 71.1364 79.9182 55.4806' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M62.1442 6.52701C65.6967 8.60229 68.9061 11.2009 71.6667 14.2172' stroke='%238993BE' stroke-width='2' stroke-linecap='round'/%3E%3Cpath d='M11.3086 38.2034C11.3086 38.2034 13.5167 41.5575 16.9242 41.3193C20.3318 41.081 22.0516 37.4522 22.0516 37.4522M18.1449 58.7766C18.1449 58.7766 23.8094 54.872 31.061 54.3649C38.3125 53.8578 43.9281 56.9737 43.9281 56.9737M34.2526 36.599C34.2526 36.599 36.2089 39.9708 39.8682 39.7149C43.5276 39.459 44.9956 35.8478 44.9956 35.8478' stroke='%238993BE' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/svg%3E%0A"), url("data:image/svg+xml,%3Csvg width='152' height='150' viewBox='0 0 152 150' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M147.38 72.8499C153.437 95.1096 155.456 105.228 141.323 129.511C127.191 153.794 94.8556 149.747 72.6806 149.747C32.5402 149.747 0 117.131 0 76.8971C0 36.6632 34.5591 0 74.6995 0C114.84 0 141.323 50.5902 147.38 72.8499Z' fill='%23555C7C'/%3E%3C/svg%3E"); + } + .page-not-found::before { + background-image: url("data:image/svg+xml,%3Csvg width='160' height='109' viewBox='0 0 160 109' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M1 7.99999C1 4.134 4.13401 1 8 1H95.1429H152C155.866 1 159 4.13401 159 8V100.571C159 104.437 155.866 107.571 152 107.571H8C4.13401 107.571 1 104.437 1 100.571V7.99999Z' stroke='%238993BE' stroke-width='2'/%3E%3Cline x1='1' y1='17.8571' x2='83.5714' y2='17.8571' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='100.429' y1='17.8571' x2='116.714' y2='17.8571' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='128.429' y1='17.8571' x2='159' y2='17.8571' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Ccircle cx='8.57138' cy='9.7142' r='1.85714' stroke='%238993BE' stroke-width='2'/%3E%3Ccircle cx='17.7142' cy='9.7142' r='1.85714' stroke='%238993BE' stroke-width='2'/%3E%3Ccircle cx='26.8573' cy='9.7142' r='1.85714' stroke='%238993BE' stroke-width='2'/%3E%3Cline x1='33.9856' y1='38.2856' x2='41.4608' y2='45.7608' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='34.4762' y1='45.761' x2='41.9513' y2='38.2858' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='105.414' y1='38.2856' x2='112.889' y2='45.7608' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cline x1='105.905' y1='45.761' x2='113.38' y2='38.2858' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M49.8545 69.0772C49.8545 69.0772 57.5257 73.6485 72.1402 73.6485C86.7117 73.6485 94.4259 69.0771 94.4259 69.0771' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M72.1526 78.5698C72.3093 86.3002 68.3437 92.6498 63.2953 92.7521C58.2469 92.8544 54.0273 86.6706 53.8707 78.9402C53.8129 76.0901 54.3155 73.4277 55.2261 71.1969' stroke='%238993BE' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'/%3E%3Cpath d='M64.6687 73.7268C64.8334 73.1997 64.5396 72.6388 64.0125 72.4741C63.4853 72.3093 62.9245 72.6031 62.7597 73.1303L64.6687 73.7268ZM61.8707 88.7359C61.9615 89.2807 62.4768 89.6487 63.0215 89.5579C63.5663 89.4671 63.9343 88.9519 63.8435 88.4071L61.8707 88.7359ZM62.7597 73.1303C61.2791 77.8683 60.9909 83.4569 61.8707 88.7359L63.8435 88.4071C63.009 83.4002 63.2922 78.1317 64.6687 73.7268L62.7597 73.1303Z' fill='%238993BE'/%3E%3C/svg%3E%0A"), url("data:image/svg+xml,%3Csvg width='172' height='170' viewBox='0 0 172 170' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M85.7456 16.9208C110.886 -6.48267 132.959 -4.28052 156.498 15.4794C180.037 35.2393 174.047 84.4687 153.005 119.028C128.204 159.761 84.2197 174.845 40.8539 167.344C-2.51188 159.842 -6.55002 107.678 7.88005 65.9713C22.3101 24.2642 60.6055 40.3243 85.7456 16.9208Z' fill='%23555C7C'/%3E%3C/svg%3E%0A"); + } +} diff --git a/src/docs/styles/_menu.scss b/src/docs/styles/_menu.scss new file mode 100644 index 000000000..331b72bb7 --- /dev/null +++ b/src/docs/styles/_menu.scss @@ -0,0 +1,85 @@ +// =================================================== +// Menu +// =================================================== +.menu { + // z-index: 8; + transition: 0.3s ease all; + // Menu container + background: var(--menu-back-color); + border-top: 1px solid var(--menu-border-color); + @media screen and (max-width: calc(#{$layout-medium-breakpoint} - 1px)) { + position: fixed; + bottom: 0; + width: 100vw; + z-index: 1001; + } + @media screen and (min-width: $layout-medium-breakpoint) { + border-top: none; + border-right: 1px solid var(--menu-border-color); + padding-top: 17vh; + } + @media screen and (min-width: $layout-large-breakpoint) { + padding-top: 23.5vh; + } + // Menu buttons + .menu-button { + cursor: pointer; + transition: 0.3s ease all; + background: transparent; + color: var(--menu-fore-color); + display: inline-block; + width: 25%; + height: 61px; + margin: 0; + text-align: center; + margin-top: 0.5rem; + border: none; + line-height: 61px; + @media screen and (min-width: $layout-medium-breakpoint) { + height: 12.5vh; + width: 100%; + margin-top: 1vh; + margin-bottom: 4vh; + line-height: 12.5vh; + } + @media screen and (min-width: $layout-large-breakpoint) { + margin-bottom: 1vh; + } + &:hover, &:focus { + outline: 0; + color: var(--menu-active-fore-color); + } + &.active { + color: var(--menu-active-fore-color); + svg { + color: var(--menu-active-fore-color); + } + } + svg { + color: var(--menu-fore-color); + } + &:last-of-type { + vertical-align: top; + } + } +} + +// Animate transition between light and dark mode +.cross-fade-leave { + transform: scale(1); +} +.cross-fade-leave.cross-fade-leave-active { + transition: all 0.3s cubic-bezier(0.47, 0, 0.745, 0.715); + transform: scale(0.1); +} +.cross-fade-enter { + transform: scale(0.1); +} +.cross-fade-enter.cross-fade-enter-active { + transition: all 0.3s cubic-bezier(0.215, 0.610, 0.355, 1); + transform: scale(0.95) +} +.cross-fade-height { + height: 61px; + transition: height 0.15s ease-in-out 0.15s; +} \ No newline at end of file diff --git a/src/docs/styles/_reset.scss b/src/docs/styles/_reset.scss new file mode 100644 index 000000000..e4744fb45 --- /dev/null +++ b/src/docs/styles/_reset.scss @@ -0,0 +1,135 @@ +// Set up some basic styling for everything +html { + font-size: 16px; + scroll-behavior: smooth; +} +html, * { + font-family: 'Noto Sans', Helvetica, sans-serif; + line-height: 1.5; + // Prevent adjustments of font size after orientation changes in mobile. + -webkit-text-size-adjust: 100%; +} +* { + font-size: 1rem; + font-weight: 400; +} +// Apply fixes and defaults as necessary for modern browsers only +a, b, del, em, i, ins, q, span, strong, u { + transition: 0.3s ease all; + font-size: 1em; // Fix for elements inside headings not displaying properly. +} +body { + margin: 0; + color: var(--fore-color); + background: var(--background-color); + overflow-x: hidden; + &.card-page { + background: var(--card-page-color); + } +} +// Correct display for Edge & Firefox. +details { + display: block; +} +// Correct display in all browsers. +summary { + display: list-item; +} +// Abbreviations +abbr[title] { + border-bottom: none; // Remove bottom border in Firefox 39-. + text-decoration: underline dotted; // Opinionated style-fix for all browsers. +} +// Show overflow in Edge. +input { + overflow: visible; +} +// Correct the cursor style of increment and decrement buttons in Chrome. +[type="number"]::-webkit-inner-spin-button, [type="number"]::-webkit-outer-spin-button { + height: auto; +} +// Correct style in Chrome and Safari. +[type="search"] { + -webkit-appearance: textfield; + outline-offset: -2px; +} +// Correct style in Chrome and Safari. +[type="search"]::-webkit-search-cancel-button, [type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} +// Make images responsive by default. +img { + max-width: 100%; + height: auto; +} +// Style headings according to material design guidelines +h1, h2, h3, h4, h5, h6 { + line-height: 1.2; + margin: 0.75rem 0.5rem; +} +h1 { + font-size: 6rem; + &.landing-title { + font-size: 3rem; + text-align: center; + & small { + display: block; + margin-top: 0.5rem; + color: var(--secondary-fore-color); + } + margin-bottom: 4rem; + } +} +h2 { + font-size: 3.75rem; +} +h3 { + font-size: 3rem; +} +h4 { + font-size: 2.125rem; +} +h5 { + font-size: 1.5rem; +} +h6 { + font-size: 1.25rem; +} +// Style textual elements +p { + margin: 0.5rem; +} +ol, ul { + margin: 0.5rem; + padding-left: 1rem; +} +b, strong { + font-weight: 600; +} +hr { + // Fixes and defaults for styling + box-sizing: content-box; + border: 0; + // Actual styling using variables + line-height: 1.25em; + margin: 0.5rem; + height: 1px; + background: linear-gradient(to right, transparent, var(--border-color) 20%, var(--border-color) 80%, transparent); +} +sup, sub, code, kbd { + line-height: 0; + position: relative; + vertical-align: baseline; +} +a { + text-decoration: none; + &:link{ + color: var(--a-link-color); + } + &:visited { + color: var(--a-visited-color); + } + &:hover, &:focus { + text-decoration: underline; + } +} diff --git a/src/docs/styles/_search.scss b/src/docs/styles/_search.scss new file mode 100644 index 000000000..ccdae2fb7 --- /dev/null +++ b/src/docs/styles/_search.scss @@ -0,0 +1,57 @@ +// =================================================== +// Search +// =================================================== +[type="search"].search-box { + transition: 0.3s ease all; + margin: 0.25rem 0.875rem; + width: calc(100% - 1.75rem); + background: var(--search-back-color); + box-shadow: 0px 4px 8px var(--search-shadow-color); + &:focus { + box-shadow: 0px 6px 12px var(--search-shadow-focus-color); + } + border-radius: 1.125rem; + outline: none; + box-sizing: border-box; + border: none; + padding-left: 2.5rem; + font-size: 1.125rem; + font-weight: 300; + line-height: 2; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='%23C5C6CD' stroke-width='1.5' stroke-linecap='round' strokelinejoin='round' className='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); + background-repeat: no-repeat; + background-position-x: 10px; + background-position-y: 8px; + color: var(--search-fore-color); + &::placeholder { + color: var(--search-placeholder-color); + } + @media screen and (min-width: $layout-large-breakpoint) { + font-size: 1.375rem; + line-height: 1.8; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23C5C6CD' stroke-width='1.5' stroke-linecap='round' strokelinejoin='round' className='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); + } +} +// Dark mode +.page-container.dark [type="search"].search-box { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='%23999EBD' stroke-width='1.5' stroke-linecap='round' strokelinejoin='round' className='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); + @media screen and (min-width: $layout-large-breakpoint) { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23999EBD' stroke-width='1.5' stroke-linecap='round' strokelinejoin='round' className='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); + } +} + +.search-box::-webkit-input-placeholder { + font-family: 'Noto Sans', Helvetica, sans-serif; +} + +.search-box:-ms-input-placeholder { + font-family: 'Noto Sans', Helvetica, sans-serif; +} + +.search-box:-moz-placeholder { + font-family: 'Noto Sans', Helvetica, sans-serif; +} + +.search-box::-moz-placeholder { + font-family: 'Noto Sans', Helvetica, sans-serif; +} \ No newline at end of file diff --git a/src/docs/styles/_toast.scss b/src/docs/styles/_toast.scss new file mode 100644 index 000000000..ef1de925b --- /dev/null +++ b/src/docs/styles/_toast.scss @@ -0,0 +1,33 @@ +// =================================================== +// Toast +// =================================================== +.toast { + position: fixed; + bottom: 16px; + margin-bottom: 0; + font-size: 0.75rem; + line-height: 1.5; + left: 50%; + transform: translate(-50%, -50%); + z-index: 1111; + color: var(--toast-fore-color); + background: var(--toast-back-color); + border-radius: 2rem; + padding: 0.375rem 1.375rem 0.375rem 2.75rem; + box-shadow: 0px 0.25rem 0.5rem var(--toast-shadow-color); + transition: all 0.3s ease; + // Toast icon + &::before { + position: absolute; + content: ''; + display: block; + top: 1px; + left: 1px; + height: 28px; + background: white; + width: 28px; + border-radius: 100%; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%2305A864' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-check'%3E%3Cpolyline points='20 6 9 17 4 12'%3E%3C/polyline%3E%3C/svg%3E"); + background-position: center; + } +} \ No newline at end of file diff --git a/src/docs/styles/index.scss b/src/docs/styles/index.scss new file mode 100644 index 000000000..5efbdc51e --- /dev/null +++ b/src/docs/styles/index.scss @@ -0,0 +1,14 @@ +// Layout breakpoints +$layout-medium-breakpoint: 600px; +$layout-large-breakpoint: 900px; + +@import 'fonts'; +@import 'colors'; +@import 'reset'; +@import 'layout'; +@import 'menu'; +@import 'search'; +@import 'button'; +@import 'card'; +@import 'code'; +@import 'toast'; diff --git a/src/docs/templates/SnippetPage.js b/src/docs/templates/SnippetPage.js new file mode 100644 index 000000000..8753df4e8 --- /dev/null +++ b/src/docs/templates/SnippetPage.js @@ -0,0 +1,107 @@ +import React from 'react'; +import { graphql } from 'gatsby'; +import { connect } from 'react-redux'; + +import Meta from '../components/Meta'; +import Shell from '../components/Shell'; +import SnippetCard from '../components/SnippetCard'; +import BackArrowIcon from '../components/SVGs/BackArrowIcon'; +import AniLink from 'gatsby-plugin-transition-link/AniLink'; + +// =================================================== +// Individual snippet page template +// =================================================== +const SnippetPage = props => { + const post = props.data.markdownRemark; + const postData = props.data.snippetDataJson.data.find( + v => v.title === post.frontmatter.title, + ); + + return ( + <> + + + + +   Back to {props.lastPageTitle} + + + + + ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(SnippetPage); + +export const pageQuery = graphql` + query BlogPostBySlug($slug: String!) { + logo: file(absolutePath: { regex: "/logo_reverse_md.png/" }) { + id + childImageSharp { + fixed(height: 45, width: 45) { + src + } + } + } + allMarkdownRemark { + edges { + node { + fields { + slug + } + fileAbsolutePath + frontmatter { + title + } + } + } + } + markdownRemark(fields: { slug: { eq: $slug } }) { + id + fields { + slug + } + excerpt(pruneLength: 160) + html + frontmatter { + title + } + } + snippetDataJson(meta: { type: { eq: "snippetArray" } }) { + data { + title + id + attributes { + text + codeBlocks { + code + example + } + tags + } + } + } + } +`; diff --git a/src/docs/templates/TagPage.js b/src/docs/templates/TagPage.js new file mode 100644 index 000000000..59c38ce64 --- /dev/null +++ b/src/docs/templates/TagPage.js @@ -0,0 +1,84 @@ +import React from 'react'; +import { graphql } from 'gatsby'; +import { connect } from 'react-redux'; +import { pushNewPage } from '../state/app'; + +import Meta from '../components/Meta'; +import Shell from '../components/Shell'; +import SnippetCard from '../components/SnippetCard'; + +import { capitalize, getRawCodeBlocks as getCodeBlocks } from '../util'; + +// =================================================== +// Individual snippet category/tag page +// =================================================== +const TagRoute = props => { + const posts = props.data.allMarkdownRemark.edges; + const tag = props.pageContext.tag; + + React.useEffect(() => { + props.dispatch(pushNewPage(capitalize(tag), props.path)); + }, []); + + return ( + <> + + +

{capitalize(tag)}

+

Click on a snippet's name to view its code.

+ {posts && + posts.map(({ node }) => ( + v.trim()), + id: node.fields.slug.slice(1), + }} + isDarkMode={props.isDarkMode} + /> + ))} +
+ + ); +}; + +export default connect( + state => ({ + isDarkMode: state.app.isDarkMode, + lastPageTitle: state.app.lastPageTitle, + lastPageUrl: state.app.lastPageUrl, + searchQuery: state.app.searchQuery, + }), + null, +)(TagRoute); + +export const tagPageQuery = graphql` + query TagPage($tagRegex: String) { + allMarkdownRemark( + limit: 1000 + sort: { fields: [frontmatter___title], order: ASC } + filter: { frontmatter: { tags: { regex: $tagRegex } } } + ) { + totalCount + edges { + node { + excerpt(pruneLength: 400) + id + html + rawMarkdownBody + fields { + slug + } + frontmatter { + title + tags + } + } + } + } + } +`; diff --git a/src/docs/util/index.js b/src/docs/util/index.js new file mode 100644 index 000000000..62c5251e9 --- /dev/null +++ b/src/docs/util/index.js @@ -0,0 +1,130 @@ +const config = require('../../../config'); + +// Capitalizes the first letter of a string +const capitalize = (str, lowerRest = false) => + str.slice(0, 1).toUpperCase() + + (lowerRest ? str.slice(1).toLowerCase() : str.slice(1)); + +// Get the textual content in a gatsby page +const getTextualContent = (str, noExplain = false) => { + const regex = /([\s\S]*?)
{ + results.push(match); + }); + } + if(noExplain) + return results[1].slice(0, results[1].lastIndexOf('

')); + return results[1]; +}; + +// Gets the code blocks in a gatsby page +const getCodeBlocks = str => { + const regex = //g; + let results = []; + let m = null; + while ((m = regex.exec(str)) !== null) { + if (m.index === regex.lastIndex) regex.lastIndex += 1; + // eslint-disable-next-line + m.forEach((match, groupIndex) => { + results.push(match); + }); + } + const replacer = new RegExp( + `

([\\s\\S]*?)
`, + 'g', + ); + const optionalReplacer = new RegExp( + `
([\\s\\S]*?)
`, + 'g', + ); + results = results.map(v => + v + .replace(replacer, '$1') + .replace(optionalReplacer, '$1') + .trim() + ); + if (results.length > 2) + return { + style: results[0], + code: results[1], + example: results[2] + }; + return { + style: '', + code: results[0], + example: results[1] + }; +}; + +// Optimizes nodes in an HTML string +const optimizeNodes = (data, regexp, replacer) => { + let count = 0; + let output = data; + do { + output = output.replace(regexp, replacer); + count = 0; + while (regexp.exec(output) !== null) ++count; + } while (count > 0); + return output; +}; +const optimizeAllNodes = html => { + let output = html; + // Optimize punctuation nodes + output = optimizeNodes( + output, + /([^\0<]*?)<\/span>([\n\r\s]*)([^\0]*?)<\/span>/gm, + (match, p1, p2, p3) => + `${p1}${p2}${p3}`, + ); + // Optimize operator nodes + output = optimizeNodes( + output, + /([^\0<]*?)<\/span>([\n\r\s]*)([^\0]*?)<\/span>/gm, + (match, p1, p2, p3) => + `${p1}${p2}${p3}`, + ); + // Optimize keyword nodes + output = optimizeNodes( + output, + /([^\0<]*?)<\/span>([\n\r\s]*)([^\0]*?)<\/span>/gm, + (match, p1, p2, p3) => `${p1}${p2}${p3}`, + ); + return output; +}; + +// Gets the code blocks for a snippet file. +const getRawCodeBlocks = str => { + const regex = /```[.\S\s]*?```/g; + let results = []; + let m = null; + while ((m = regex.exec(str)) !== null) { + if (m.index === regex.lastIndex) regex.lastIndex += 1; + // eslint-disable-next-line + m.forEach((match, groupIndex) => { + results.push(match); + }); + } + const replacer = new RegExp( + `\`\`\`${config.language}([\\s\\S]*?)\`\`\``, + 'g', + ); + results = results.map(v => v.replace(replacer, '$1').trim()); + return { + code: results[0], + example: results[1], + }; +}; + +module.exports = { + capitalize, + getTextualContent, + getCodeBlocks, + optimizeNodes, + optimizeAllNodes, + getRawCodeBlocks, +};